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

fix issue with image model docstrings #8524

Merged
merged 1 commit into from May 12, 2022

Conversation

lb-
Copy link
Member

@lb- lb- commented May 11, 2022

  • asterisk was being parsed as markdown and not rendering correctly in the documentation
  • Used Note: instead of * as a reference to the rendition.

before

Screen Shot 2022-05-12 at 7 59 39 am

after

Screen Shot 2022-05-12 at 7 59 05 am

* asterisk was being parsed as markdown and not rendering correctly in the documentation
@squash-labs
Copy link

squash-labs bot commented May 11, 2022

Manage this branch in Squash

Test this branch here: https://lb-fiximage-models-docstring-2fnpk.squash.io

@lb-
Copy link
Member Author

lb- commented May 11, 2022

Flagging as 3.0 due to this section being added in 3.0 but probably not a release blocker.

@zerolab
Copy link
Contributor

zerolab commented May 12, 2022

Is it me or the theme doesn't correctly handle the nested "New in <VERSION>" block? The after screenshot has a load of extra padding

@lb-
Copy link
Member Author

lb- commented May 12, 2022

Oh I think that is related to the way that our latest built docs use the latest version of Sphinx Wagtail theme probably.

@lb-
Copy link
Member Author

lb- commented May 12, 2022

Before screenshot was on docs.wagtail but after screenshot was on my local

Copy link
Contributor

@zerolab zerolab left a comment

Choose a reason for hiding this comment

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

LGTM.
This is one to keep in mind for future docblocks

@gasman gasman merged commit ca1c69b into wagtail:main May 12, 2022
gasman pushed a commit that referenced this pull request May 12, 2022
* asterisk was being parsed as markdown and not rendering correctly in the documentation
@lb- lb- deleted the fix/image-models-docstring branch May 12, 2022 20:31
stevedya pushed a commit to stevedya/wagtail that referenced this pull request May 18, 2022
* asterisk was being parsed as markdown and not rendering correctly in the documentation
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

3 participants