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

style arguments to make their correspondence with their description more legible #868

Open
glyph opened this issue Jan 23, 2025 · 2 comments · May be fixed by #872
Open

style arguments to make their correspondence with their description more legible #868

glyph opened this issue Jan 23, 2025 · 2 comments · May be fixed by #872

Comments

@glyph
Copy link
Member

glyph commented Jan 23, 2025

from https://docs.twisted.org/en/stable/api/twisted.internet.interfaces.IReactorProcess.html#spawnProcess

consider this presentation:

Image

it is extremely hard to see where args ends and env begins. two things would be helpful here:

  1. env should be vertically aligned with the beginning of its description, rather than floating in the middle, and
  2. there should be some visual separation — probably a hairline, but at least some whitespace greater than a standard intra-description paragraph break — between each argument's description
@glyph glyph changed the title add stylesheet to make arguments' correspondence with their description more legible style arguments so their correspondence with their description more legible Jan 23, 2025
@glyph glyph changed the title style arguments so their correspondence with their description more legible style arguments to make their correspondence with their description more legible Jan 23, 2025
@tristanlatr
Copy link
Contributor

Thanks for creating this issue, I totally agree. I’ll fix this before next release.

@glyph
Copy link
Member Author

glyph commented Jan 23, 2025

Thanks for creating this issue, I totally agree. I’ll fix this before next release.

Thanks! I was mainly making a note so I wouldn't forget about this, but if you have the time to actually fix it nicely, so much the better ;)

@tristanlatr tristanlatr linked a pull request Jan 24, 2025 that will close this issue
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 a pull request may close this issue.

2 participants