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

fixing python documentation formatting #104

Draft
wants to merge 1 commit into
base: fastsim-2
Choose a base branch
from

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

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