aiohttp icon indicating copy to clipboard operation
aiohttp copied to clipboard

Documentation formatting is... unusual

Open dimaqq opened this issue 6 years ago • 3 comments

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.

dimaqq avatar Oct 02 '19 06:10 dimaqq

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

The PR is welcome!

asvetlov avatar Oct 02 '19 11:10 asvetlov

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

Harmon758 avatar Oct 28 '19 21:10 Harmon758

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.

asvetlov avatar Oct 28 '19 21:10 asvetlov