Add thorough documentation for the djblets_utils template tags.

Review Request #7738 — Created Oct. 25, 2015 and submitted

Information

Djblets
release-0.9.x

Reviewers

djblets_utils is one of the oldest modules in Djblets, and its
documentation was really lacking. This change fleshes it out, bringing
it up to current standards, and adds examples showing how to use all the
tags.

This started off as some cleanups to appease Sphinx, but ended up
becoming a complete rewrite of the docs.

Built the docs and read through them.

Description From Last Updated

In the other docstrings, you use "Example:" instead of "Examples:".

AD adriano

Typo: "value" should be "key".

AD adriano

undefined name 'value'

reviewbotreviewbot

"Turns" is the wrong tense (use something like "Turn"?).

AD adriano
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        djblets/util/templatetags/djblets_utils.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        djblets/util/templatetags/djblets_utils.py
    
    
  2.  undefined name 'value'
    
  3. 
      
AD
  1. 
      
  2. In the other docstrings, you use "Example:" instead of "Examples:".

    1. Good catch.

    2. For the record, both work, but it's good to be consistent :)

  3. Typo: "value" should be "key".

  4. Should this be "(int, optional)"?

    1. Sure. There's no real standard for any of this yet, which is kinda annoying :(

  5. "Turns" is the wrong tense (use something like "Turn"?).

  6. Another opportunity for "(unicode, optional)"?

  7. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        djblets/util/templatetags/djblets_utils.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        djblets/util/templatetags/djblets_utils.py
    
    
  2. 
      
AD
  1. Ship It!
    1. Heheh. Always wanted to do this. =]

  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-0.9.x (12a7c27)
Loading...