Skip to content

Conversation

@Mega-JC
Copy link
Member

@Mega-JC Mega-JC commented May 15, 2023

The initial change was made while doing docs style improvements, however it is ultimately more beneficial and widespread to have .. note:: reST blocks stand out. It makes them harder to overlook, thus making it less likely for users to miss important details.

Before

image

After

image

@Mega-JC Mega-JC requested a review from a team as a code owner May 15, 2023 23:15
@Mega-JC Mega-JC changed the title Reveal 'Note:' reST block background color again Reveal .. note:: reST block background color again May 15, 2023
@yunline yunline added the docs label May 16, 2023
@Starbuck5
Copy link
Member

This increases the amount of emphasis the notes get, which is interesting. It's good in some cases, but I feel in other cases the previous content is now emphasized too much. So they should be changed away "notes" in that case.

Some candidates that might not want to be notes after this PR:
draw: see the pygame.gfxdraw...
font: every getter/setter note
controller: see the pygame.joystick...

@Starbuck5
Copy link
Member

This also will have implications for #2122. Since I believe this PR will be merged before that one, that will need to be rebased and updated to support these changes. Heads up @Notenlish

Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like how this looks in general. I think we can handle demoting blocks from being attention grabbing notes in other PRs over time.

@Mega-JC Mega-JC force-pushed the docs-highlighted-note-blocks branch from 0edc96f to d86ebd4 Compare May 31, 2023 18:09
@itzpr3d4t0r
Copy link
Member

itzpr3d4t0r commented Jul 1, 2023

As predicted this doesn't work well with dark theme right now:
image
VS light theme:
image

The initial change was made while doing docs style improvements, however it is ultimately more beneficial and widespread to make '.. note::' reST blocks stand out.
@Mega-JC Mega-JC force-pushed the docs-highlighted-note-blocks branch 2 times, most recently from e96c12b to 3989d24 Compare July 5, 2023 11:30
@Mega-JC Mega-JC force-pushed the docs-highlighted-note-blocks branch from 3989d24 to 28ef841 Compare July 5, 2023 11:36
@Mega-JC
Copy link
Member Author

Mega-JC commented Jul 5, 2023

I've now added custom theme colors for the dark mode as well.

image

Copy link
Member

@zoldalma999 zoldalma999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks!

@itzpr3d4t0r itzpr3d4t0r merged commit 0f78666 into pygame-community:main Jul 8, 2023
@MightyJosip MightyJosip added this to the 2.3.1 milestone Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants