Skip to content
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

docs(api_split.pug): add "code" to parameter name #12145

Merged
merged 1 commit into from Jul 25, 2022

Conversation

hasezoey
Copy link
Collaborator

Summary

This changes Documentation Parameter names from "someOption" to someOption, which in my opinion is better to read

before:
before img

after:
after img

before/after with darkreader before:

before img

after:
after img

@hasezoey
Copy link
Collaborator Author

By the way, should the headers maybe also be wrapped in code-blocks too?

Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

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

You're right, much easier to read. Thanks!

@vkarpov15 vkarpov15 added this to the 6.4.7 milestone Jul 25, 2022
@vkarpov15
Copy link
Collaborator

@hasezoey headers would be a good idea too. As long as that doesn't screw up header ids.

@vkarpov15 vkarpov15 merged commit a1c63ba into Automattic:master Jul 25, 2022
@hasezoey hasezoey deleted the addCodeToParameters branch July 26, 2022 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants