Skip to content

fixing python documentation formatting#104

Draft
robinsteuteville wants to merge 1 commit intofastsim-2from
fix-python-documentation
Draft

fixing python documentation formatting#104
robinsteuteville wants to merge 1 commit intofastsim-2from
fix-python-documentation

Conversation

@robinsteuteville
Copy link
Collaborator

No description provided.

@robinsteuteville
Copy link
Collaborator Author

@robinsteuteville
Copy link
Collaborator Author

@calbaker I was able to fix the copy_sim_drive documentation formatting, although I had to add a line of description in order to do so -- the line can be changed or updated as needed. I figured out two things. One, from what I can tell it seems like in order for an argument to be recognized as such, it has to have a description on the same line as the argument (so, argument: xxxxxxx, all on one line). Two, any additional lines of description for an argument (like the bullet points in copy_sim_drive) must align with the beginning of the first line of description. Here's the updated docstring for copy_sim_drive:
Screenshot 2024-01-31 at 10 15 09 AM
And here's the resulting format:
Screenshot 2024-01-31 at 10 15 46 AM

@kylecarow kylecarow force-pushed the fastsim-2 branch 4 times, most recently from 9ec70df to 70adb5f Compare February 4, 2026 00:28
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.

1 participant