Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jt-lab
Copy link
Contributor

@jt-lab jt-lab commented Nov 30, 2023

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.

@codecov-commenter
Copy link

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (2d4b260) 89.83% compared to head (4c71cc6) 89.83%.

Files Patch % Lines
bambi/model_components.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #765   +/-   ##
=======================================
  Coverage   89.83%   89.83%           
=======================================
  Files          45       45           
  Lines        3768     3768           
=======================================
  Hits         3385     3385           
  Misses        383      383           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tomicapretto
Copy link
Collaborator

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!

@tomicapretto
Copy link
Collaborator

one incomplete doc strings (see formula.py l19; is this correct?)

yes that is correct :)

@tomicapretto
Copy link
Collaborator

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 :)

@jt-lab
Copy link
Contributor Author

jt-lab commented Mar 17, 2024 via email

@tomicapretto
Copy link
Collaborator

Yes, I think you can pull the most recent version. Maybe there will be some conflicts. Let me know if you need any help :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants