configuration docs

Issue #1074 resolved
Former user created an issue

The first paragraph calls SATCHMO_SETTINGS a tuple, and it doesn't have the dict keys in the example in quotes.

And I think the subsequent list of settings should be represented like: {{{ SATCHMO_SETTINGS['SHOP_BASE'] Default: '/shop' }}}

Comments (8)

  1. Tay Ray Chuan
    • changed status to open

    Regarding s/tuple/dictionary/ - definitely.

    Regarding the attribute-form - not very convinced. Is this really important? In any case, your patch (and by extension, baee60003227 ) does not cover all bases and breaks various cross-references.

    Regarding the s/`/'/ - for strings, perhaps, but for Python keywords, the `` form should be kept.

  2. Chris Moffitt repo owner

    I do want to make sure it's clear to people that this is a dictionary, not a tuple. I'm not sure that these changes accomplish that. I understand it causes problems with sphinx - i just want to try to minimize any potential confusion.

  3. Former user Account Deleted

    Sorry, I don't know about sphinx. I just think the settings dictionary and its keys/default values should be accurately represented so as not to confuse the reader.

  4. Log in to comment