[Checkins] [zopefoundation/zope.interface] bde1bb: Place code in ``code`` formatting.

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/zopefoundation/zope.interface
  Commit: bde1bb8fc7a5212ac22f25eb8077fabd51afd18b
      https://github.com/zopefoundation/zope.interface/commit/bde1bb8fc7a5212ac22f25eb8077fabd51afd18b
  Author: Michael McNeil Forbes <michael.forbes+github at gmail.com>
  Date:   2014-10-29 (Wed, 29 Oct 2014)

  Changed paths:
    M src/zope/interface/document.py

  Log Message:
  -----------
  Place code in ``code`` formatting.

With the previous version of the code, function signatures etc. get inserted as plain text.  A common python construct ``f(**kw)`` thus generates error since structured text thinks this is the start of **bold** text, but then complains because the start tag ``**`` is never closed.

The solution here is to place all code in double hash tags so it is formatted verbatim without interpreting characters as inline markup.

(Technically, this might only be supported by reStructuredText, but since this is the standard for python documentation, that is probably fine.


  Commit: 48127c88e70ce1641589eb4d861a6c76e4a31aac
      https://github.com/zopefoundation/zope.interface/commit/48127c88e70ce1641589eb4d861a6c76e4a31aac
  Author: Michael McNeil Forbes <michael.forbes+github at gmail.com>
  Date:   2014-10-29 (Wed, 29 Oct 2014)

  Changed paths:
    M src/zope/interface/document.py

  Log Message:
  -----------
  Fix typo.


  Commit: 1f1569f26d79b85bb925366c3d836f13acc2997f
      https://github.com/zopefoundation/zope.interface/commit/1f1569f26d79b85bb925366c3d836f13acc2997f
  Author: Michael McNeil Forbes <michael.forbes+github at gmail.com>
  Date:   2014-10-29 (Wed, 29 Oct 2014)

  Changed paths:
    M src/zope/interface/tests/test_document.py

  Log Message:
  -----------
  Updated tests.


  Commit: 226e352a672989ad6bc4586494b906adb1f493db
      https://github.com/zopefoundation/zope.interface/commit/226e352a672989ad6bc4586494b906adb1f493db
  Author: Michael McNeil Forbes <michael.forbes+numpy at gmail.com>
  Date:   2014-10-29 (Wed, 29 Oct 2014)

  Changed paths:
    M src/zope/interface/tests/test_document.py

  Log Message:
  -----------
  Merge remote-tracking branch 'origin/patch-2' into patch-1


  Commit: fda5f35756691b3f8af1e42fc83574f2f31c03a0
      https://github.com/zopefoundation/zope.interface/commit/fda5f35756691b3f8af1e42fc83574f2f31c03a0
  Author: Michael McNeil Forbes <michael.forbes+numpy at gmail.com>
  Date:   2014-10-29 (Wed, 29 Oct 2014)

  Changed paths:
    M src/zope/interface/document.py
    M src/zope/interface/tests/test_document.py

  Log Message:
  -----------
  Added new function asreStructuredTest to keep backward compatibility
- To keep code clean, functionality is implemented in asStructuredText
  with an added flag rst with default value False to preserve behaviour.


  Commit: 853b078ec76baa68216f9aa805474eaec8805bb4
      https://github.com/zopefoundation/zope.interface/commit/853b078ec76baa68216f9aa805474eaec8805bb4
  Author: Michael McNeil Forbes <michael.forbes+numpy at gmail.com>
  Date:   2014-10-30 (Thu, 30 Oct 2014)

  Changed paths:
    M src/zope/interface/document.py
    M src/zope/interface/tests/test_document.py

  Log Message:
  -----------
  Changed name to asReStructuredText for CamelCase correctness.


  Commit: a85a4b0f448661d34f3d058b488b0252d828f766
      https://github.com/zopefoundation/zope.interface/commit/a85a4b0f448661d34f3d058b488b0252d828f766
  Author: Michael McNeil Forbes <michael.forbes+numpy at gmail.com>
  Date:   2014-10-30 (Thu, 30 Oct 2014)

  Changed paths:
    M CHANGES.rst

  Log Message:
  -----------
  Updated CHANGES.rst.


  Commit: e804db87ea757415fd0cb9e7f6daf825eeae3553
      https://github.com/zopefoundation/zope.interface/commit/e804db87ea757415fd0cb9e7f6daf825eeae3553
  Author: Tres Seaver <tseaver at palladion.com>
  Date:   2014-10-30 (Thu, 30 Oct 2014)

  Changed paths:
    M CHANGES.rst

  Log Message:
  -----------
  Flesh out changelog entry for 'asReStructuredText'.


Compare: https://github.com/zopefoundation/zope.interface/compare/438df9bc2c53...e804db87ea75