Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhance doc of os.stat_result #66012

Closed
vstinner opened this issue Jun 20, 2014 · 6 comments
Closed

Enhance doc of os.stat_result #66012

vstinner opened this issue Jun 20, 2014 · 6 comments
Labels
docs Documentation in the Doc dir

Comments

@vstinner
Copy link
Member

BPO 21813
Nosy @vstinner, @zware
Files
  • stat_result.patch
  • stat_result.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2014-07-24.10:45:32.987>
created_at = <Date 2014-06-20.09:18:22.837>
labels = ['docs']
title = 'Enhance doc of os.stat_result'
updated_at = <Date 2014-07-24.13:46:46.182>
user = 'https://github.com/vstinner'

    bugs.python.org fields:

    activity = <Date 2014-07-24.13:46:46.182>
actor = 'zach.ware'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-07-24.10:45:32.987>
closer = 'vstinner'
components = ['Documentation']
creation = <Date 2014-06-20.09:18:22.837>
creator = 'vstinner'
dependencies = []
files = ['35704', '35705']
hgrepos = []
issue_num = 21813
keywords = ['patch']
message_count = 6.0
messages = ['221080', '221086', '221087', '223825', '223826', '223834']
nosy_count = 4.0
nosy_names = ['vstinner', 'docs@python', 'python-dev', 'zach.ware']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue21813'
versions = ['Python 3.4', 'Python 3.5']
    @vstinner
    Copy link
    Member Author

    Attached patch creates a stat_result class in the os documentation and complete the documentation of each field. It makes possible to link directly an attribute of this class in the documentation, which is useful for the new st_file_attributes (issue bpo-21719) for example.

    @vstinner vstinner added the docs Documentation in the Doc dir label Jun 20, 2014
    @zware
    Copy link
    Member

    zware commented Jun 20, 2014

    Rietveld didn't like an escape code at the beginning of your patch; here's the last 12,039 bytes of it which will hopefully make Rietveld happy.

    @vstinner
    Copy link
    Member Author

    ...an escape code at the beginning of your patch...

    Yeah, these days I suffer because of the issue bpo-19884 (readline issue in Mercurial).

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jul 24, 2014

    New changeset 833325d45113 by Victor Stinner in branch '3.4':
    Issue bpo-21813: Enhance documentation of the os.stat_result class.
    http://hg.python.org/cpython/rev/833325d45113

    New changeset 5d70ac83d104 by Victor Stinner in branch 'default':
    Issue bpo-21813: Enhance documentation of the os.stat_result class.
    http://hg.python.org/cpython/rev/5d70ac83d104

    @vstinner
    Copy link
    Member Author

    Thanks Zachary Ware for your review. I'm not sure that I addressed all your comments, but I'm not interested to spend too much time on the documentation. Please open an issue if your saw other things that can be improved.

    @zware
    Copy link
    Member

    zware commented Jul 24, 2014

    The only comments you didn't address you were right not to (sorry for the noise about path_fd, I completely missed that it was just a link reference); what you committed looks fine to me.

    Thanks for your work on this, it looks like a big improvement to me!

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @vstinner @zware