Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

DOC: Format aliases in kwargs tables #29088

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

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Nov 5, 2024

The primary property name was given as link and code-formatted but the aliases were plain-text.

image

This PR adds consistent formatting to the aliases as well, but still does not link them (by setting the ! prefix).

@timhoffm timhoffm marked this pull request as draft November 5, 2024 20:47
@timhoffm
Copy link
Member Author

timhoffm commented Nov 5, 2024

Not exactly how I anticipated this to look like:

image

Need to find out whether there is a better way.

The primary property name was given as link and code-formatted but the aliases were plain-text. This PR adds consistent formatting to the aliases as well, but still does not link them (by setting the `!` prefix).
@timhoffm
Copy link
Member Author

timhoffm commented Nov 5, 2024

Ok, changed now to proper links:

image

Note: Also the aliases now link to the original setter. While one could link ec to set_ec, the docstrings of the aliases only state "Alias of set_edgecolor" and do not contain actual information. Therefore, it's better to directly link to the original property setter.

@timhoffm timhoffm marked this pull request as ready for review November 5, 2024 23:05
@QuLogic QuLogic added this to the v3.10.0 milestone Nov 5, 2024
@QuLogic QuLogic merged commit 57b4149 into matplotlib:main Nov 6, 2024
39 of 43 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 6, 2024
@timhoffm timhoffm deleted the doc-color-none branch November 6, 2024 05:15
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.

2 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.