[Checkins] [zopefoundation/ZConfig] 0225b3: Move loader documentation to docstrings.

GitHub noreply at github.com
Fri Feb 10 18:18:05 CET 2017


  Branch: refs/heads/docs
  Home:   https://github.com/zopefoundation/ZConfig
  Commit: 0225b3ca8078a060dedba9b5bc0860040e56d157
      https://github.com/zopefoundation/ZConfig/commit/0225b3ca8078a060dedba9b5bc0860040e56d157
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-02-10 (Fri, 10 Feb 2017)

  Changed paths:
    M ZConfig/loader.py
    M doc/py-mod-loader.rst

  Log Message:
  -----------
  Move loader documentation to docstrings.

Fixes the signature for Resource and the description of the missing
`fragment` attr.

Also remove unused import from that module.

Make the two classes it defines (BaseLoader and Resource) extend
object for more consistent behaviour on Py2 and Py3.


  Commit: 8069a24b44a9a7ecb7b9976d61193f4658f1fd01
      https://github.com/zopefoundation/ZConfig/commit/8069a24b44a9a7ecb7b9976d61193f4658f1fd01
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-02-10 (Fri, 10 Feb 2017)

  Changed paths:
    M ZConfig/cmdline.py
    M doc/py-mod-cmdline.rst

  Log Message:
  -----------
  Move cmdline docs to docstrings.

Also make OptionBag a new-style class on Py2 for consistency.

Document why MatcherMixin can't be a new-style class on Py2.


  Commit: 8c4cd69fb162845b67283fbcfd7f6a685ca35cfe
      https://github.com/zopefoundation/ZConfig/commit/8c4cd69fb162845b67283fbcfd7f6a685ca35cfe
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-02-10 (Fri, 10 Feb 2017)

  Changed paths:
    M ZConfig/datatypes.py
    M doc/py-mod-datatypes.rst

  Log Message:
  -----------
  Move datatypes documentation to docstrings.

Also make public classes descend from object on Py2 for consistency.


  Commit: 0b8e2e54541b133feb0d656a99be7415d237f313
      https://github.com/zopefoundation/ZConfig/commit/0b8e2e54541b133feb0d656a99be7415d237f313
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-02-10 (Fri, 10 Feb 2017)

  Changed paths:
    M ZConfig/substitution.py
    M doc/py-mod-subst.rst

  Log Message:
  -----------
  Move substitition to docstrings


  Commit: a63c88eb540acace2c7c3318dd331af1f9ad3042
      https://github.com/zopefoundation/ZConfig/commit/a63c88eb540acace2c7c3318dd331af1f9ad3042
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2017-02-10 (Fri, 10 Feb 2017)

  Changed paths:
    M ZConfig/__init__.py
    M ZConfig/cmdline.py
    M ZConfig/loader.py
    M doc/py-mod-zconfig.rst

  Log Message:
  -----------
  Move ZConfig docs to docstrings.

Be sure to keep the exception constructor signatures hidden.

Also move the "value specifier" docs to ExtendedConfigLoader where
they are defined and reference them from there.


Compare: https://github.com/zopefoundation/ZConfig/compare/0225b3ca8078^...a63c88eb540a


More information about the checkins mailing list