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

Usability: Function documentation is not clearly separated #58

@fuglede

Description

@fuglede

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions