Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Make documentation rustier #559

Open
MicahGale opened this issue Sep 30, 2024 · 4 comments · May be fixed by #608
Open

Make documentation rustier #559

MicahGale opened this issue Sep 30, 2024 · 4 comments · May be fixed by #608
Assignees
@MicahGale
Labels
documentation Improvements or additions to documentation feature request An issue that improves the user interface. good first issue Good for newcomers
Milestone
M&C workshop

Comments

@MicahGale
Copy link
Collaborator

In Rust there is an expectation that doc strings will include examples.

This could be a good idea to start including more and more in our doc strings.

Along with this we would need to implement doctest in pytest.

Is this a good paradigm?
@MicahGale MicahGale added documentation Improvements or additions to documentation feature request An issue that improves the user interface. labels Sep 30, 2024
@tjlaboss
Copy link
Collaborator

yes

@MicahGale MicahGale added the good first issue Good for newcomers label Oct 15, 2024
@tjlaboss tjlaboss mentioned this issue Oct 16, 2024
Closed
@tjlaboss
Copy link
Collaborator

doctest is now implemented, opening this up

@MicahGale
Copy link
Collaborator Author

Right. Probably need to create a new convention for docstrings including examples as well a reference to the MCNP manuals.

@MicahGale
Copy link
Collaborator Author

Should I add this to the big todo list for the 1.0.0 alpha release?

This was referenced Nov 13, 2024
Merged
Open
@MicahGale MicahGale added this to the 1.0.0-alpha milestone Nov 14, 2024
@MicahGale MicahGale self-assigned this Nov 14, 2024
This was referenced Nov 29, 2024
Open
Draft
@MicahGale MicahGale modified the milestones: 1.0.0-alpha, M&C workshop Jan 11, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@MicahGale MicahGale

Labels
documentation Improvements or additions to documentation feature request An issue that improves the user interface. good first issue Good for newcomers
Projects
None yet
Milestone
M&C workshop
Development

Successfully merging a pull request may close this issue.

1.0.0 alpha to develop staging idaholab/MontePy
2 participants
@MicahGale @tjlaboss