Skip to content
This repository has been archived by the owner on Dec 31, 2021. It is now read-only.

Usability: Function documentation is not clearly separated #58

Open
fuglede opened this issue Nov 27, 2019 · 3 comments · Fixed by #70
Open

Usability: Function documentation is not clearly separated #58

fuglede opened this issue Nov 27, 2019 · 3 comments · Fixed by #70

Comments

@fuglede
Copy link

fuglede commented Nov 27, 2019

Looking at the documentation for ufuncs, http://generated-numpy-docs-14648-2-sphinx2.surge.sh/reference/ufuncs.html, I've noted a few changed compared to the existing documentation which I think are regressions, usability wise:

  • The text is much wider and takes up the entire screen. While this is nice on mobile (cf. Style: Horizontal space is underutilized on mobile #48) it seems unintended on a wide screen (but may just be an artifact of Bug: Responsiveness bugs out on some pages #57).
  • Previously there would be formatting in place to clearly separate e.g. function arguments from other parts of the documentation, just like it was clear what was a subsection of what. This is not the case in the new layout, which, and this is a personal opinion, I think is a step backwards.

Screenshots for reference:

Before:

before

Now:

now

@Shekharrajak
Copy link
Member

First part is fixed here: https://pr-73-scipy-sphinx-theme-v2.surge.sh/ PR #73

@fuglede
Copy link
Author

fuglede commented Jan 17, 2020

I can't seem to find any function documentation strings on that page; is there a new one available for the NumPy documentation where I originally noticed the issue as well? Edit: Sorry, I was referring to the second part, the first part seems much better!

@Shekharrajak
Copy link
Member

Thanks for reviewing and confirmation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants