Opened 5 weeks ago

Closed 5 weeks ago

Last modified 5 weeks ago

#35457 closed Cleanup/optimization (wontfix)

Documentation: Code inside of text box

Reported by: Treyson Grange Owned by: sammy20d
Component: Uncategorized Version: 5.0
Severity: Normal Keywords: Documentation
Cc: Adam Johnson Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: yes

Description (last modified by Treyson Grange)

The first section of example code for Field name restrictions is inside of a text box, ridding it of the usual code formatting and styling.

Change History (5)

comment:1 by Treyson Grange, 5 weeks ago

Description: modified (diff)

comment:2 by Treyson Grange, 5 weeks ago

Description: modified (diff)
Owner: Treyson Grange removed
Status: assignednew

This has been done on purpose, as blaken-docs breaks when it tries to interpret pass = ... for the same reasons the example is showed in the first place. Don't believe there is a way around this.

comment:3 by sammy20d, 5 weeks ago

Owner: set to sammy20d
Status: newassigned

comment:4 by Sarah Boyce, 5 weeks ago

Cc: Adam Johnson added
Resolution: wontfix
Status: assignedclosed

Hello! Thank you for raising and I agree that we cannot currently do this.
There is a feature suggested to add blacken-docs on/off comments: https://github.com/adamchainz/blacken-docs/issues/193 which we could potentially use in feature.

I will close this as 'wontfix' but we can reopen/address this if this feature is to land in blacken-docs 👍

comment:5 by Adam Johnson, 5 weeks ago

Yeah. There’s an open PR in blacken-docs but it needs significant rework before merging and I haven't prioritized it.

Note: See TracTickets for help on using tickets.
Back to Top