Skip to content

Fix NUTS docstring formatting to match HMC and HMCDA style#2818

Merged
penelopeysm merged 2 commits into
TuringLang:mainfrom
ArpanC6:fix/nuts-docstring-formatting
Apr 29, 2026
Merged

Fix NUTS docstring formatting to match HMC and HMCDA style#2818
penelopeysm merged 2 commits into
TuringLang:mainfrom
ArpanC6:fix/nuts-docstring-formatting

Conversation

@ArpanC6
Copy link
Copy Markdown
Contributor

@ArpanC6 ArpanC6 commented Apr 26, 2026

What does this PR do?

This PR addresses the inconsistency in the docstring formatting for NUTS compared to HMC and HMCDA in the same file.

Changes made

Added header comments (e.g., # Usage, # Arguments) to the corresponding sections for better structure.
Fixed formatting by removing extra spaces before colons in argument lists (e.g., changed n_adapts::Int : to n_adapts::Int:).
Corrected a missing closing parenthesis in the method signature in the docstring header.
Ensured the style aligns with the formatting used in the HMC and HMCDA docstrings making everything consistent.

Why?

Consistent docstring formatting improves the readability of the API documentation and aligns it with Julia’s documentation standards used throughout the file.

@ArpanC6
Copy link
Copy Markdown
Contributor Author

ArpanC6 commented Apr 26, 2026

@yebai @penelopeysm This is my first contribution to Turing.jl.
Please let me know if any changes are needed.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.23%. Comparing base (89b1ce0) to head (56e93a9).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2818   +/-   ##
=======================================
  Coverage   85.23%   85.23%           
=======================================
  Files          22       22           
  Lines        1483     1483           
=======================================
  Hits         1264     1264           
  Misses        219      219           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@penelopeysm penelopeysm left a comment

Choose a reason for hiding this comment

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

Thanks!

@penelopeysm penelopeysm merged commit 3e6b26f into TuringLang:main Apr 29, 2026
@ArpanC6
Copy link
Copy Markdown
Contributor Author

ArpanC6 commented Apr 29, 2026

Thanks!

Welcome

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