-
-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixed typos, fixed one incomplete doc strings, etc. #765
Conversation
…this correct?), made docstring punctation and emphasis (more) consistent.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #765 +/- ##
==========================================
- Coverage 89.71% 89.41% -0.31%
==========================================
Files 47 47
Lines 3997 4023 +26
==========================================
+ Hits 3586 3597 +11
- Misses 411 426 +15 ☔ View full report in Codecov by Sentry. |
Hi @jt-lab thanks a lot for taking care of this! I think double backticks (``) are not needed anymore since we're using Quarto and not sphinx for the docs. Could you adapt those cases to use single backticks? If you want, you can also try to build the documentation locally and see if it works. But if you can't or simply don't want, just let me know and I'll check it on my end. Thanks again! |
yes that is correct :) |
Hi @jt-lab, do you think you have time to incorporate my comments? I could do it for you if you want, so we get this merged :) |
Hi Tomás,
yes I can, I have done some of it already locally. Sorry for the delay. I'll be on a conference next week but after it I can finish it. How will it merge most smoothly? Can I pull the most recent version despite there already being a PR based on some old version?
…On Mar 17, 2024, 15:10, at 15:10, "Tomás Capretto" ***@***.***> wrote:
Hi @jt-lab, do you think you have time to incorporate my comments? I
could do it for you if you want, so we get this merged :)
--
Reply to this email directly or view it on GitHub:
#765 (comment)
You are receiving this because you were mentioned.
Message ID: ***@***.***>
|
Yes, I think you can pull the most recent version. Maybe there will be some conflicts. Let me know if you need any help :) |
Fixed typos, one incomplete doc strings (see formula.py l19; is this correct?), made docstring punctuation and emphasis (more) consistent:
Single line docstrings end with '.'
Multi-line part docstrings' first lines are "titles", without period at their ends
Further paragraphs end with '.'
All lines under 'parameters', 'returns' etc. end with '.'
This scheme was derived from the most common cases in the current version, and I have tried to consistently apply it where there were differences.