Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#26021 closed Cleanup/optimization (fixed)

Standardize on hanging indent in documentation

Reported by: Tim Graham Owned by: Ed Henderson
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Most of the documentation using 4 space hanging indent, but there are a few places where it needs to be cleaned up. I attached a patch to give some examples and get you started.

Rules to follow:

  • The closing parenthesis goes on its own line, aligned with the line that contains the opening parenthesis.
  • Include a trailing comma after the last kwarg or item in the dict or tuple so more items can be added later without modifying that line again.

Any questions, let me know.

Attachments (1)

indent.diff (5.3 KB ) - added by Tim Graham 8 years ago.

Download all attachments as: .zip

Change History (12)

by Tim Graham, 8 years ago

Attachment: indent.diff added

comment:1 by Tim Graham, 8 years ago

Summary: Standardize on hanging indent in documentaionStandardize on hanging indent in documentation

comment:2 by Anurag Sharma, 8 years ago

Owner: changed from nobody to Anurag Sharma
Status: newassigned

comment:3 by Chris Cogdon, 8 years ago

In utils.txt, (new) line 670, there's no trailing comma. It kinda makes sense that there isn't one, since the function has exactly three arguments, but checking to see if that was intended.

comment:4 by Tim Graham, 8 years ago

It's not critical either way, but I find it easiest to always add the comma so you don't have to think about it. You never know if a function might gain new arguments too.

comment:5 by Tim Graham <timograham@…>, 8 years ago

In e475e849:

Refs #26021 -- Used hanging indentation in some doc examples.

comment:6 by Tim Graham <timograham@…>, 8 years ago

In dbd72b8:

[1.9.x] Refs #26021 -- Used hanging indentation in some doc examples.

Backport of e475e849703d937e158e75e7a6d9cb99090857f6 from master

comment:7 by Tim Graham, 8 years ago

Easy pickings: set
Owner: Anurag Sharma removed
Status: assignednew

I'm sure there are other places to revise, but I committed my patch for now since no one has picked this up in a while and those weird indentations bother me when I see them.

comment:8 by Ed Henderson, 8 years ago

Owner: set to Ed Henderson
Status: newassigned

comment:9 by Tim Graham <timograham@…>, 8 years ago

Resolution: fixed
Status: assignedclosed

In 4a4d7f98:

Fixed #26021 -- Applied hanging indentation to docs.

comment:10 by Tim Graham <timograham@…>, 8 years ago

In 6d0c9f9:

[1.9.x] Fixed #26021 -- Applied hanging indentation to docs.

Backport of 4a4d7f980e2a66756e1e424f7648dcd28ff765b7 from master

comment:11 by Tim Graham <timograham@…>, 8 years ago

In 521772ff:

[1.10.x] Fixed #26021 -- Applied hanging indentation to docs.

Backport of 4a4d7f980e2a66756e1e424f7648dcd28ff765b7 from master

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