[issue26267] UUID docs should say how to get "standard form"

Roundup Robot added the comment: New changeset 1a25c639f81e by Berker Peksag in branch '3.5': Issue #26267: Improve uuid.UUID documentation https://hg.python.org/cpython/rev/1a25c639f81e New changeset c9e944cc6301 by Berker Peksag in branch '3.6': Issue #26267: Merge from 3.5

[issue26267] UUID docs should say how to get "standard form"

Berker Peksag added the comment: Thanks, Ammar. -- resolution: -> fixed stage: patch review -> resolved status: open -> closed versions: +Python 3.7 ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Ammar Askar added the comment: I've updated the patch to document the comparison operators in prose instead of with markup as requested. -- Added file: http://bugs.python.org/file45807/uuiddocs.diff5 ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Berker Peksag added the comment: I wouldn't consider it a problem since both forms are supported. Also note that you don't need to specify the "UUID." prefix when you use the indented form: .. class:: UUID(...) .. attribute:: bytes I don't think the benefit here is worth the

[issue26267] UUID docs should say how to get "standard form"

Ammar Askar added the comment: Done. As a side question, are changes like those indentation problems tracked somewhere else/merged in bulk like spelling changes? -- Added file: http://bugs.python.org/file43988/uuiddocs.diff4 ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Berker Peksag added the comment: > It also indents the attributes and descriptions to emphasize that they are > part of the UUID instance, not the uuid module. Thanks for the patch, but please revert unrelated changes. -- nosy: +berker.peksag stage: needs patch -> patch review

[issue26267] UUID docs should say how to get "standard form"

Ammar Askar added the comment: Whoops, didn't export the patch properly there so it didn't get picked up by the review tool, this should fix it. -- Added file: http://bugs.python.org/file43980/uuiddocs.diff3 ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Ammar Askar added the comment: Fixed the str() representation as per Evelyn's comment. -- Added file: http://bugs.python.org/file43979/uuiddocs.diff2 ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Ammar Askar added the comment: This patch adds documentation for the str(uuid) operator along with documenting the fact that UUID instances support comparisons with `>` and `<`. It also indents the attributes and descriptions to emphasize that they are part of the UUID instance, not the uuid

[issue26267] UUID docs should say how to get "standard form"

Changes by SilentGhost : -- nosy: -SilentGhost ___ Python tracker ___ ___

[issue26267] UUID docs should say how to get "standard form"

Changes by Berker Peksag : -- keywords: +easy stage: -> needs patch versions: +Python 3.5, Python 3.6 ___ Python tracker ___

[issue26267] UUID docs should say how to get "standard form"

SilentGhost added the comment: Well, you seem to suggest we add something to documentation to accommodate people who don't read it in the first place. -- ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Changes by Timo Furrer : -- nosy: +tuxtimo ___ Python tracker ___ ___ Python-bugs-list

[issue26267] UUID docs should say how to get "standard form"

New submission from Andrew Barnert: Most real-world code that uses the UUID module wants either the standard format '{12345678-1234-5678-1234-567812345678}', or the same thing without the braces. There are a number of different documented accessors, but none of them give you either of these.

[issue26267] UUID docs should say how to get "standard form"

Andrew Barnert added the comment: > The docs seem to clearly show a str(x) as the way to produce the desired form > (without braces). https://docs.python.org/3/library/uuid.html#example Please read the last paragraph of the original message. -- ___

[issue26267] UUID docs should say how to get "standard form"

SilentGhost added the comment: The docs seem to clearly show a str(x) as the way to produce the desired form (without braces). https://docs.python.org/3/library/uuid.html#example -- nosy: +SilentGhost ___ Python tracker

[issue26267] UUID docs should say how to get "standard form"

Georg Brandl added the comment: Andrew is right, this should be documented "properly". -- nosy: +georg.brandl ___ Python tracker ___

[issue26267] UUID docs should say how to get "standard form"

Andrew Barnert added the comment: No, I suggest we add something for users who don't think that a comment in an example is the place to look for documentation, but do think that actual documentation of a class or method is. -- ___ Python tracker