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

Move note about repeated calls to json.dump using the same fp to the json.dump section #78560

Closed
eallrich mannequin opened this issue Aug 10, 2018 · 4 comments
Closed

Move note about repeated calls to json.dump using the same fp to the json.dump section #78560

eallrich mannequin opened this issue Aug 10, 2018 · 4 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@eallrich
Copy link
Mannequin

eallrich mannequin commented Aug 10, 2018

BPO 34379
Nosy @methane, @miss-islington, @eallrich
PRs
  • bpo-34379: Move note for json.dump to function's docs #8730
  • [3.7] bpo-34379: Doc: Move note for json.dump (GH-8730) #8735
  • [3.6] bpo-34379: Doc: Move note for json.dump (GH-8730) #8736
    		•

    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 2018-08-11.09:13:33.946>
created_at = <Date 2018-08-10.22:10:19.008>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Move note about repeated calls to json.dump using the same fp to the json.dump section'
updated_at = <Date 2018-08-11.09:13:33.891>
user = 'https://github.com/eallrich'

    bugs.python.org fields:

    activity = <Date 2018-08-11.09:13:33.891>
actor = 'methane'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-08-11.09:13:33.946>
closer = 'methane'
components = ['Documentation']
creation = <Date 2018-08-10.22:10:19.008>
creator = 'eallrich'
dependencies = []
files = []
hgrepos = []
issue_num = 34379
keywords = ['patch']
message_count = 4.0
messages = ['323396', '323407', '323408', '323409']
nosy_count = 4.0
nosy_names = ['methane', 'docs@python', 'miss-islington', 'eallrich']
pr_nums = ['8730', '8735', '8736']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34379'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']
    @eallrich
    Copy link
    Mannequin Author

    eallrich mannequin commented Aug 10, 2018

    At present the note [0] appears under the documentation for json.dumps (which does not use the fp argument). It seems the note would be better placed with the documentation for the affected function.

    [0]

    Note

    Unlike pickle and marshal, JSON is not a framed protocol, so trying to > serialize multiple objects with repeated calls to dump() using the same > fp will result in an invalid JSON file.

    @eallrich eallrich mannequin added the 3.7 (EOL) end of life label Aug 10, 2018
    @eallrich eallrich mannequin assigned docspython Aug 10, 2018
    @eallrich eallrich mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Aug 10, 2018
    @methane
    Copy link
    Member

    methane commented Aug 11, 2018

    New changeset 9e84084 by INADA Naoki (Evan Allrich) in branch 'master':
    bpo-34379: Doc: Move note for json.dump (GH-8730)
    9e84084

    @miss-islington
    Copy link
    Contributor

    New changeset 6b14508 by Miss Islington (bot) in branch '3.7':
    bpo-34379: Doc: Move note for json.dump (GH-8730)
    6b14508

    @methane
    Copy link
    Member

    methane commented Aug 11, 2018

    New changeset eb6ed12 by INADA Naoki (Miss Islington (bot)) in branch '3.6':
    bpo-34379: Doc: Move note for json.dump (GH-8730)
    eb6ed12

    @methane methane added the 3.8 only security fixes label Aug 11, 2018
    @methane methane closed this as completed Aug 11, 2018
    @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 3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @methane @miss-islington