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.

Sign up for GitHub

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

Jump to bottom

Documentation formatting is... unusual #4127

Open
dimaqq opened this issue Oct 2, 2019 · 3 comments
Open

Documentation formatting is... unusual #4127

dimaqq opened this issue Oct 2, 2019 · 3 comments
Labels
bug documentation Improvements or additions to documentation

Comments

@dimaqq
Copy link
Contributor

dimaqq commented Oct 2, 2019

Why is Parameters: displayed as a column?

Screenshot 2019-10-02 at 15 31 40

It could be manually fixed with min-width: 6em on that div...

OTH, if the intention was to use a column-looking label, then the better way would be to use writing-mode.
@asvetlov
Copy link
Member

asvetlov commented Oct 2, 2019

It is not intended.
After a brief look, I was unable to find the source of bad formatting.

The PR is welcome!

@Harmon758 Harmon758 added the documentation Improvements or additions to documentation label Oct 28, 2019
@Harmon758
Copy link
Member

It seems like it's the code blocks in the parameter descriptions that's causing this.

@asvetlov
Copy link
Member

I suspect, yes. We can left :param: block short and simple, extract the detailed parameter description into a separate parameter below params enumerations.

Need a champion for the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@asvetlov @dimaqq @Dreamsorcerer @Harmon758