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.

Sign up for GitHub

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

Document that time.tzset updates time module globals #72317

Closed
abalkin opened this issue Sep 13, 2016 · 7 comments
Closed

Document that time.tzset updates time module globals #72317

abalkin opened this issue Sep 13, 2016 · 7 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir easy

Comments

@abalkin
Copy link
Member

abalkin commented Sep 13, 2016

BPO 28130
Nosy @abalkin, @lisroach, @Mariatta, @gbengeult
Files
  • tzset_doc.patch
  • tzset_rst.patch
  • tzset_rst_27.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 2017-01-12.20:06:45.371>
created_at = <Date 2016-09-13.16:01:46.659>
labels = ['easy', '3.7', 'docs']
title = 'Document that time.tzset updates time module globals'
updated_at = <Date 2017-01-12.20:06:45.370>
user = 'https://github.com/abalkin'

    bugs.python.org fields:

    activity = <Date 2017-01-12.20:06:45.370>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-01-12.20:06:45.371>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2016-09-13.16:01:46.659>
creator = 'belopolsky'
dependencies = []
files = ['45135', '46275', '46276']
hgrepos = []
issue_num = 28130
keywords = ['patch', 'easy']
message_count = 7.0
messages = ['276294', '278911', '285337', '285340', '285341', '285343', '285345']
nosy_count = 6.0
nosy_names = ['belopolsky', 'docs@python', 'python-dev', 'lisroach', 'Mariatta', 'gbengeult']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue28130'
versions = ['Python 2.7', 'Python 3.7']
    @abalkin
    Copy link
    Member Author

    abalkin commented Sep 13, 2016

    Reported by MAL in bpo-22798 (msg251840):

    "The fact that tzset() does update the module globals is
    not documented."

    The documentation should explicitly list timezone, daylight, altzone and tzname as the globals that are updated when time.tzset() is called.

    @abalkin abalkin added docs Documentation in the Doc dir easy labels Sep 13, 2016
    @abalkin abalkin changed the title Document that time.tzset updates time module constants Document that time.tzset updates time module globals Sep 14, 2016
    @lisroach
    Copy link
    Contributor

    Will this simple update be enough? Or should more documentation be added for clarification?

    @gbengeult
    Copy link
    Mannequin

    gbengeult mannequin commented Jan 12, 2017

    How about this documentation patch for tzset()? Most of the verbiage comes from the Linux tzset() man page. I can also generate a similar patch for 2.7 if it's needed.

    @gbengeult gbengeult mannequin added the 3.7 (EOL) end of life label Jan 12, 2017
    @abalkin
    Copy link
    Member Author

    abalkin commented Jan 12, 2017

    Committed in ec3b08b361c0. Thanks, Greg.

    Leaving open until 2.7 docs are fixed as well.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jan 12, 2017

    New changeset ec3b08b361c0 by Alexander Belopolsky in branch 'default':
    Closes bpo-28130: Documented that time.tzset() updates time module globals.
    https://hg.python.org/cpython/rev/ec3b08b361c0

    @python-dev python-dev mannequin closed this as completed Jan 12, 2017
    @abalkin abalkin reopened this Jan 12, 2017
    @gbengeult
    Copy link
    Mannequin

    gbengeult mannequin commented Jan 12, 2017

    Here's the 2.7 patch.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jan 12, 2017

    New changeset 8578757cc3a6 by Alexander Belopolsky in branch '2.7':
    Closes bpo-28130: Documented that time.tzset() updates time module globals.
    https://hg.python.org/cpython/rev/8578757cc3a6

    @python-dev python-dev mannequin closed this as completed Jan 12, 2017
    @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
    3.7 (EOL) end of life docs Documentation in the Doc dir easy
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @abalkin @lisroach