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

Question: Section heading level choice #91

Open
zachcran opened this issue Aug 29, 2024 · 4 comments
Open

Question: Section heading level choice #91

zachcran opened this issue Aug 29, 2024 · 4 comments

Comments

@zachcran
Copy link
Contributor

zachcran commented Aug 29, 2024

docstrfmt uses the section heading characters = > - > ~ > + > . > ,. What is your motivation for using these characters, as opposed to the section header characters that Python suggests and Sphinx recommends (# > * > = > - > ^ > ")?

I know it doesn't matter to the reST specification, but I'm curious since docstrfmt goes against what I know of as the standard.

@LilSpazJoekp
Copy link
Owner

That was what it was in rstfmt and this project is a fork of it and I didn't think to change it.

@zachcran
Copy link
Contributor Author

zachcran commented Aug 29, 2024

rstfmt actually seems to have updated their section headers to the standard set by Python and Sphinx that I mentioned above (see their latest sample.rst). Would you be open to updating as well?

@LilSpazJoekp
Copy link
Owner

Absolutely! I'll get this updated as well!

@zachcran
Copy link
Contributor Author

That is great, thank you! I really like the project so far btw!

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

No branches or pull requests

2 participants