Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: make signature background grey #11421

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

Conversation

ImportanceOfBeingErnest
Copy link
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest commented Jun 12, 2018

PR Summary

This is a follow up on #11411 where the signatures in the documentation did get a slightly larger font size. In addition, to give the docs a clearer structure, one could give the background of the signature lines a slight shade of grey. This allows for a better visual separation between several classes and functions.

Before:

image

After:

image

@phobson
Copy link
Member

phobson commented Jun 12, 2018

maybe it's my monitor, but i can't tell a difference in the background colors between those two screen shots.

@ImportanceOfBeingErnest
Copy link
Member Author

@phobson Thanks for pointing that out. The following two images could make this clearer (left is the case from the current online docs, right is the case implemented here). I did not want to make that grey too strong, but I do find that it helps giving some structure for the eye on pages where lots of classes/methods/attributes are documented.

imageimage

@phobson
Copy link
Member

phobson commented Jun 12, 2018

Thanks for the side-by-side. But still, on my set up, I can't detect a difference between the two backgrounds. The rest of the changes are nice.

@ImportanceOfBeingErnest
Copy link
Member Author

Mhh, the background of the signatures is the only thing I'm changing here. Other differences like links, fontsize etc. have been changed elsewhere in the meantime.

Maybe we wait for other people to have a look and see how they view it.

@jklymak
Copy link
Member

jklymak commented Jun 12, 2018

I think @phobson is angling for a GoFundMe for a new monitor...

@phobson
Copy link
Member

phobson commented Jun 13, 2018

Good news, everyone. I can see the difference on my monitor at home.

@timhoffm
Copy link
Member

timhoffm commented Jun 16, 2018

Proposal: Could you change the dl* > dt elements to

    background-color: #f4f4fb;
    padding: 1px 6px;
  • adds a very slight blue touch to the background. IMO much less depressing.
  • use the same values for top and bottom padding.

grafik

@ImportanceOfBeingErnest ImportanceOfBeingErnest force-pushed the doc_greybackground-for-signatures branch from 8282f0e to 68f9da8 Compare June 18, 2018 10:37
@ImportanceOfBeingErnest
Copy link
Member Author

While I'm not sure what would be depressing about the background, I now changed it to #eff3f4, which is the same color that even row numbers have in tables. I also left a slightly bigger padding towards the top (2px) as I think otherwise this looks too compressed. This is the current look:

image

@ImportanceOfBeingErnest ImportanceOfBeingErnest force-pushed the doc_greybackground-for-signatures branch from 68f9da8 to 1edd593 Compare June 19, 2018 15:15
@jklymak jklymak merged commit 341070a into matplotlib:master Jun 19, 2018
@QuLogic QuLogic added this to the v3.0.0 milestone Nov 27, 2018
@ImportanceOfBeingErnest ImportanceOfBeingErnest deleted the doc_greybackground-for-signatures branch February 17, 2019 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants