Code

Opened 6 years ago

Closed 6 years ago

Last modified 3 years ago

#8705 closed (fixed)

Indentation problem in topics/db/models.txt

Reported by: Horst Gutmann <zerok@…> Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: rst, indentation
Cc: zerok@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The definition list of field options is rendered as blockquotes (and nested blockquotes). Fixed in attached patch.

Attachments (3)

indentation_modelstxt.diff (2.6 KB) - added by Horst Gutmann <zerok@…> 6 years ago.
t8705.png (118.3 KB) - added by ramiro 6 years ago.
t8705_r8767.diff (2.0 KB) - added by ramiro 6 years ago.
New version of the patch with unneeded trailing spaces removed

Download all attachments as: .zip

Change History (10)

Changed 6 years ago by Horst Gutmann <zerok@…>

comment:1 Changed 6 years ago by richardb

  • milestone set to 1.0
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Tried out the patch, works as intended and fixes the incorrect rendering in the documentation.

To the original submitter: in future, can you submit patches in svn diff format rather than using the diff output from another Version Control tool? It will then conform to the Django patch guidelines and make life a lot easier for people (like myself) who are using the standard tools :-)

comment:2 follow-up: Changed 6 years ago by jacob

richardb: git diff format is common enough these days that we accept it. I'll update the guidelines when I get a chance.

comment:3 Changed 6 years ago by ramiro

Note to reviewers: The OP is describing the rendering in a local copy generated by make html as can be seen in the attached snapshot (Firefox 3, but it also happens with Safari 3.1.2, Konqueror 3.5 and IE7)

When I submitted #8693/[8737] (that took the opposite approach) it was guided by what I was seeing in the copy at http://docs.djangoproject.com/ so it seems the style sheets are different. This would also mean the rendering at the documentation website should be checked if/when this patch is committed.

Changed 6 years ago by ramiro

Changed 6 years ago by ramiro

New version of the patch with unneeded trailing spaces removed

comment:4 Changed 6 years ago by ubernostrum

  • Resolution set to fixed
  • Status changed from new to closed

(In [8788]) Fixed #8705: Corrected some formatting issues in models documentation

comment:5 in reply to: ↑ 2 ; follow-up: Changed 6 years ago by richardb

Replying to jacob:

richardb: git diff format is common enough these days that we accept it. I'll update the guidelines when I get a chance.

Jacob: Ok, noted.

Horst Gutmann: apologies for criticizing your patch when it was, in fact, up to expected standards :-)

comment:6 in reply to: ↑ 5 Changed 6 years ago by Horst Gutmann <zerok@…>

Replying to richardb:

Replying to jacob:

richardb: git diff format is common enough these days that we accept it. I'll update the guidelines when I get a chance.

Jacob: Ok, noted.

Horst Gutmann: apologies for criticizing your patch when it was, in fact, up to expected standards :-)

Richard: No stress :-) I actually totally missed that passage in the guidelines until today ;-)

comment:7 Changed 3 years ago by jacob

  • milestone 1.0 deleted

Milestone 1.0 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.