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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix code style of example in Wagtail API docs #9225

Merged
merged 1 commit into from
Sep 19, 2022
Merged

Fix code style of example in Wagtail API docs #9225

merged 1 commit into from
Sep 19, 2022

Conversation

Stormheg
Copy link
Member

Example code should be compliant with PEP-8.

Noticed this when reading this section of the docs and decided to volunteer a few minutes to fix it 馃榿

Looks like the class names were accidentally changed to lowercase when this section was converted to markdown in 7e73349.


Should we perhaps consider adding some sort of formatter / linter for the documentation examples to ensure our examples follow the same code style?

@squash-labs
Copy link

squash-labs bot commented Sep 19, 2022

Manage this branch in Squash

Test this branch here: https://stormheg-patch-1-u8g9z.squash.io

Example code should be compliant with PEP-8.
Copy link
Member

@lb- lb- left a comment

Choose a reason for hiding this comment

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

Thanks @Stormheg - will pull this into 4.0.2 as it was a 4.0 docs regression.

@lb-
Copy link
Member

lb- commented Sep 19, 2022

Should we perhaps consider adding some sort of formatter / linter for the documentation examples to ensure our examples follow the same code style?

@Stormheg - could you add this scenario and thoughts to the existing similar discussion about this #8753 (it is about prettier adoption in Markdown, but this is a similar underlying problem).

@lb- lb- merged commit 6a8ce31 into main Sep 19, 2022
@lb- lb- deleted the Stormheg-patch-1 branch September 19, 2022 11:49
@lb-
Copy link
Member

lb- commented Sep 19, 2022

Cherry picked to 4.0 stable 4b0ac7e

@lb- lb- added this to the 4.0.2 milestone Sep 19, 2022
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.

None yet

2 participants