[issue29428] Doctest documentation unclear about multi-line fixtures

Carol Willing added the comment: I've closed the associated PR https://github.com/python/cpython/pull/45 with a recommendation to resubmit a smaller, more atomic PR if desired. -- nosy: +willingc resolution: -> rejected stage: -> resolved status: open -> closed

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Bump. Could I get a few more eyes looking at the current state of https://github.com/python/cpython/pull/45/ ? * @bitdancer made some suggestions. I accepted some, and replied to others where I think we should keep looking for common ground. I'd like to see

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Pull Request https://github.com/python/cpython/pull/45 submitted to new Github repo. I would appreciate a review. I attempted to balance all the different opinions in the discussion below: stay concise, but also improve the clarity. -- pull_requests:

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: I've drafted some fairly restricted changes to the doctest documentation page. They are in my Github branch, https://github.com/JDLH/cpython/tree/Issue29428_doctest_docs . The diffs are at https://github.com/JDLH/cpython/commit

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Marco: > To have a wide view, usually it is a good idea to start from the beginning: > > https://groups.google.com/forum/#!msg/comp.lang.python/DfzH5Nrt05E/Yyd3s7fPVxwJ Thank you, that is a very interesting thread. Clearly the creator of doctests, Tim Peters,

[issue29371] Typo in doctest documentation

Roundup Robot added the comment: New changeset 2b20a37791e3cc4536db1f99fc85ffb6e20134ab by Mariatta Wijaya in branch '2.7': Issue #29371: Clarify bitwise OR operation in doctest option flags. https://github.com/python/cpython/commit/2b20a37791e3cc4536db1f99fc85ffb6e20134ab --

[issue29371] Typo in doctest documentation

Roundup Robot added the comment: New changeset c36939b07c1275a6c3897a917c638b0ac48885c4 by Mariatta Wijaya in branch 'master': Issue #29371: Clarify bitwise OR operation in doctest option flags. https://github.com/python/cpython/commit/c36939b07c1275a6c3897a917c638b0ac48885c4 New changeset

[issue29371] Typo in doctest documentation

Roundup Robot added the comment: New changeset c36939b07c1275a6c3897a917c638b0ac48885c4 by Mariatta Wijaya in branch '3.5': Issue #29371: Clarify bitwise OR operation in doctest option flags. https://github.com/python/cpython/commit/c36939b07c1275a6c3897a917c638b0ac48885c4 --

[issue29371] Typo in doctest documentation

Roundup Robot added the comment: New changeset c36939b07c1275a6c3897a917c638b0ac48885c4 by Mariatta Wijaya in branch '3.6': Issue #29371: Clarify bitwise OR operation in doctest option flags. https://github.com/python/cpython/commit/c36939b07c1275a6c3897a917c638b0ac48885c4 New changeset

[issue29371] Typo in doctest documentation

Mariatta Wijaya added the comment: Thanks, Marco, Jim, and Raymond :) -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker

[issue29371] Typo in doctest documentation

Roundup Robot added the comment: New changeset 3fd198b80f29 by Mariatta Wijaya in branch '2.7': Issue #29371: Clarify bitwise OR operation in doctest option flags. https://hg.python.org/cpython/rev/3fd198b80f29 -- ___ Python tracker

[issue29371] Typo in doctest documentation

Roundup Robot added the comment: New changeset df62e833eeb1 by Mariatta Wijaya in branch '3.5': Issue #29371: Clarify bitwise OR operation in doctest option flags. https://hg.python.org/cpython/rev/df62e833eeb1 New changeset c3d779f96b20 by Mariatta Wijaya in branch '3.6': Issue #29371: merge

[issue29371] Typo in doctest documentation

Mariatta Wijaya added the comment: Thanks, Raymond. I have an updated patch there the hypen and apostrophe are removed. -- versions: -Python 3.3, Python 3.4 Added file: http://bugs.python.org/file46552/issue29371v2.patch ___ Python tracker

[issue29371] Typo in doctest documentation

Raymond Hettinger added the comment: This mostly looks correct. I would change "bitwise-OR‘ed" to "bitwise ORed". That latter form without the hyphen or apostrophe matches what is used in library/winsound.rst. Once that change is made (in two places), go ahead an apply the patch. --

[issue29371] Typo in doctest documentation

Changes by Mariatta Wijaya : -- stage: -> patch review ___ Python tracker ___ ___

[issue29371] Typo in doctest documentation

Mariatta Wijaya added the comment: Hi everyone, I made a patch to clarify that "or'ed" here really means "bitwise-OR'ed", and made a reference to the section of the docs about bitwise OR. Please review and let me know if this will work. Thanks. -- keywords: +patch Added file:

[issue29428] Doctest documentation unclear about multi-line fixtures

Marco Buttu added the comment: > In parallel, I was thinking of some howto content that I would like to > see documented. Great :-) > How to decide what to test with doctests and what with unittests. > I have a feeling that the sweet spot of doctests is functionality > which you can invoke in

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Marco, thank you for the suggestion of a howto. That is a good idea. In parallel, I was thinking of some howto content that I would like to see documented. • How to decide what to test with doctests and what with unittests. I have a feeling that the sweet

[issue29428] Doctest documentation unclear about multi-line fixtures

Marco Buttu added the comment: IMO if you would like to apply big changes to the current doc, as you wrote before, maybe is worth considering to propose a separate howto, instead of wide changes to the current page. I am suggesting this to you, because looking at the other modules of the

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Marco and David, thank you again for your prompt replies. Let me respond to both of your comments on the doctest module documentation itself. [Marco] > The example in section 26.3.3.2 [1], before the compound statement (the if/else), contains two simple

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Marco, thank you for the suggestion to watch Raymond Hettinger's talk. > I suggest you to watch this talk of Raymond Hettinger, before going on: > > https://www.youtube.com/watch?v=voXVTjwnn-U That video is 63 minutes long, and a lot of those minutes are taken

[issue29428] Doctest documentation unclear about multi-line fixtures

Jim DeLaHunt added the comment: Marco, thank you for your prompt comment. However, > Maybe you are running the doctest with Python 3. The StringIO module is no > more available in Python 3, so your doctest will fail on Python 3 Please let me be clear. This issue is not about the

[issue29428] Doctest documentation unclear about multi-line fixtures

R. David Murray added the comment: And thanks for wanting to improve the docs! -- ___ Python tracker ___ ___

[issue29428] Doctest documentation unclear about multi-line fixtures

R. David Murray added the comment: It does appear that "test" is being used ambiguously in the docs. In most places it means a single statement, but in execution context it appears to be being used as a synonym for "docstring". In that section it should be replaced by "docstring". It would

[issue29428] Doctest documentation unclear about multi-line fixtures

Marco Buttu added the comment: > I just had a problem with doctests. It manifested as an > error that occurred when I did > >>> import StringIO in my doctest. Maybe you are running the doctest with Python 3. The StringIO module is no more available in Python 3, so your doctest will fail on

[issue29428] Doctest documentation unclear about multi-line fixtures

cumentation messages: 286843 nosy: JDLH, docs@python priority: normal severity: normal status: open title: Doctest documentation unclear about multi-line fixtures type: enhancement versions: Python 3.7

[issue29371] Typo in doctest documentation

Raymond Hettinger added the comment: Mariatta, would you like to look into this and opine about whether the docs are correct as-is. If you think a change is warranted, propose a patch. -- ___ Python tracker

[issue29371] Typo in doctest documentation

Changes by Raymond Hettinger : -- assignee: docs@python -> Mariatta nosy: +Mariatta, rhettinger ___ Python tracker ___

[issue29371] Typo in doctest documentation

Jim Fasarakis-Hilliard added the comment: I think it is fine as it is but, agree that it could be clearer. I'm simply not experienced enough to know if this change is warranted. The docs generally do a great job in being concise (balancing brevity and completeness). A core-dev would be best

[issue29371] Typo in doctest documentation

Marco Buttu added the comment: What about this? "Symbolic names for the flags are supplied as module constants, which can be OR'ed together (flagA | flagB | ...) and passed to various functions." -- ___ Python tracker

[issue29371] Typo in doctest documentation

Marco Buttu added the comment: I think you got the meaning. I have never read it before :/ If you think the meaning is clear enough for everyone, I close the issue. -- ___ Python tracker

[issue29371] Typo in doctest documentation

Jim Fasarakis-Hilliard added the comment: >From what I understand, "or'ed" here stands for combining the options using >`|` >(https://docs.python.org/3/reference/expressions.html#binary-bitwise-operations). You can see an example of that in the source for `doctest.py`

[issue29371] Typo in doctest documentation

New submission from Marco Buttu: >From the doctest documentation [1]: "Symbolic names for the flags are supplied as module constants, which can be or'ed together and passed to various functions." Is there a typo in "...which can be or'ed together..."? Maybe "colle

Re: Doctest documentation?

On 20/05/12 17:55:52, Steven D'Aprano wrote: Is this a bug in the doctest documentation, or is my browser broken? On this page: http://docs.python.org/library/doctest.html#option-flags-and-directives scroll down to the examples showing the doctest directives, e.g: [quote

Doctest documentation?

Is this a bug in the doctest documentation, or is my browser broken? On this page: http://docs.python.org/library/doctest.html#option-flags-and-directives scroll down to the examples showing the doctest directives, e.g: [quote] For example, this test passes: print range(20

Re: Doctest documentation?

On 20/05/12 17:55, Steven D'Aprano wrote: Is this a bug in the doctest documentation, or is my browser broken? On this page: http://docs.python.org/library/doctest.html#option-flags-and-directives scroll down to the examples showing the doctest directives, e.g: [quote

Re: Doctest documentation?

On 5/20/2012 12:33 PM, Vincent Vande Vyvre wrote: On 20/05/12 17:55, Steven D'Aprano wrote: Is this a bug in the doctest documentation, or is my browser broken? On this page: http://docs.python.org/library/doctest.html#option-flags-and-directives scroll down to the examples showing

Re: Doctest documentation?

This was previously reported as http://bugs.python.org/issue12947 -- Devin -- http://mail.python.org/mailman/listinfo/python-list