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

Docstring patches #983

Merged
merged 12 commits into from
Jul 2, 2024
Merged

Docstring patches #983

merged 12 commits into from
Jul 2, 2024

Conversation

abhro
Copy link
Contributor

@abhro abhro commented Jun 26, 2024

Major changes:

  • Use of ordered lists
  • Addition of method headers
  • More/fixed admonition blocks
  • Fixed links
  • Fixed fence code examples

For more details, please see the commit messages. Thank you!

abhro added 10 commits June 26, 2024 13:51
Extra newline causes markdown to interpret them as two different lists.
Remove newline to keep it all as one list.
Lists were already formatted as bullet lists with
extraneous numbering or as manual plaintext lists.
Copy link
Member

@ablaom ablaom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thankyou @abhro for this valuable contribution 🙏🏾 . Just a couple of minor comments.

abhro and others added 2 commits June 27, 2024 17:58
Co-authored-by: Anthony Blaom, PhD <anthony.blaom@gmail.com>
Update variable name style (and comments) to match docs
@abhro
Copy link
Contributor Author

abhro commented Jun 28, 2024

I think I've incorporated them. Thank you!

Copy link

codecov bot commented Jun 28, 2024

Codecov Report

Attention: Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.20%. Comparing base (8cb6f26) to head (08a014e).
Report is 23 commits behind head on dev.

Files Patch % Lines
src/data/data.jl 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #983      +/-   ##
==========================================
+ Coverage   88.13%   88.20%   +0.06%     
==========================================
  Files          28       28              
  Lines        2587     2585       -2     
==========================================
  Hits         2280     2280              
+ Misses        307      305       -2     

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

@ablaom ablaom merged commit 7254ee1 into JuliaAI:dev Jul 2, 2024
5 checks passed
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.

2 participants