private stuff should be private-er
Bug #997295 reported by
Glyph Lefkowitz
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pydoctor |
New
|
Undecided
|
Unassigned |
Bug Description
There is some visible indication that _-prefixed names are private when looking at the index, but when looking at the documentation for individual methods or functions, the text is on the same blue background.
Better would be a consistent style that always showed private stuff, in any context, as grey-on-grey so it's clear.
Also, the grey-on-grey doesn't ever have a textual explanation. There should be some text saying "This method is for maintainers only" and a link to a page that explains what it means to call a private method.
Finally, private methods should all be hidden by default, and shown via a "show private methods and bases" button (assuming the browser has JavaScript).
To post a comment you must log in.
Thank you for reporting three bugs at once :-)
The first should be easy (simple CSS tweak, he says confidently)
Doesn't the third subsume the second? I think if grey stuff appears when you click "show maintainer only content", that's a lesson that will be learnt pretty quickly.
The third part should be easy. I don't know if I want to write any raw js though, so I probably get to decide which js library to use first...
People who use browsers without js are clearly not using the internet anyway, so I don't _really_ care about them (maybe blind people get a pass?).