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

Documentation too wide #3057

Open
buchs opened this issue Oct 25, 2021 · 3 comments
Open

Documentation too wide #3057

buchs opened this issue Oct 25, 2021 · 3 comments
Labels
documentation This is a problem with documentation. enhancement This issue requests an improvement to a current feature. feature-request This issue requests a feature. p3 This is a minor priority issue

Comments

@buchs
Copy link

buchs commented Oct 25, 2021

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_instances

Line containing this:
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'

Is wider than the restricted maximum width of the main column containing documentation. There may be a scroll bar an incredibly far distance below but that is not useful. If I click on the text I can scroll it via an arrow key in Firefox. But that is awkward at best.

You should not have a restriction on the maximum width of the main column. The left column should be resizeable and hideable. I almost never use it - too much scrolling to be useful. I just do another search via DDG to get to a different section. However, maybe you should wrap such text so it can fit if you insist on a fixed width.

@buchs buchs added guidance Question that needs advice or information. needs-triage This issue or PR still needs to be triaged. labels Oct 25, 2021
@kdaily kdaily added documentation This is a problem with documentation. enhancement This issue requests an improvement to a current feature. feature-request This issue requests a feature. and removed guidance Question that needs advice or information. needs-triage This issue or PR still needs to be triaged. labels Oct 25, 2021
@kdaily
Copy link
Member

kdaily commented Oct 25, 2021

Thanks for the feedback, @buchs. I agree it's not the best experience. It would require adjusting (or possibly switching) the Sphinx template we're using. Marking as a feature request to improve the documentation.

@github-actions
Copy link

Greetings! It looks like this issue hasn’t been active in longer than one year. We encourage you to check if this is still an issue in the latest release. In the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please feel free to provide a comment or upvote with a reaction on the initial post to prevent automatic closure. If the issue is already closed, please feel free to open a new one.

@github-actions github-actions bot added the closing-soon This issue will automatically close in 4 days unless further comments are made. label Oct 25, 2022
@buchs
Copy link
Author

buchs commented Oct 26, 2022

Yes, github-actions bot, the problem remains. Someone in support could have easily checked this too.

@github-actions github-actions bot removed the closing-soon This issue will automatically close in 4 days unless further comments are made. label Oct 26, 2022
@aBurmeseDev aBurmeseDev added the p3 This is a minor priority issue label Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. enhancement This issue requests an improvement to a current feature. feature-request This issue requests a feature. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

3 participants