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

Some methods of profile.Profile are not supported but the docs doesn't mention it. #79692

Closed
bombs-kim mannequin opened this issue Dec 16, 2018 · 3 comments
Closed

Some methods of profile.Profile are not supported but the docs doesn't mention it. #79692

bombs-kim mannequin opened this issue Dec 16, 2018 · 3 comments
Labels
3.8 only security fixes docs Documentation in the Doc dir

Comments

@bombs-kim
Copy link
Mannequin

bombs-kim mannequin commented Dec 16, 2018

BPO 35511
Nosy @asvetlov, @bombs-kim
PRs
  • bpo-35511: Trivial docs updates for profile and resource library modules. #11124
    		•

    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-12-16.19:57:12.336>
created_at = <Date 2018-12-16.06:48:23.832>
labels = ['3.8', 'docs']
title = "Some methods of profile.Profile are not supported but the docs doesn't mention it."
updated_at = <Date 2018-12-16.19:57:12.336>
user = 'https://github.com/bombs-kim'

    bugs.python.org fields:

    activity = <Date 2018-12-16.19:57:12.336>
actor = 'asvetlov'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-12-16.19:57:12.336>
closer = 'asvetlov'
components = ['Documentation']
creation = <Date 2018-12-16.06:48:23.832>
creator = 'bombs-kim'
dependencies = []
files = []
hgrepos = []
issue_num = 35511
keywords = ['patch']
message_count = 3.0
messages = ['331917', '331918', '331935']
nosy_count = 3.0
nosy_names = ['asvetlov', 'docs@python', 'bombs-kim']
pr_nums = ['11124']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue35511'
versions = ['Python 3.8']
    @bombs-kim
    Copy link
    Mannequin Author

    bombs-kim mannequin commented Dec 16, 2018

    Currently enable, disable methods are only supported by Profile class of cProfile module, not profile module. But the docs doesn't give this information. I think we should, at least mention it, in the docs.

    @bombs-kim bombs-kim mannequin added the 3.8 only security fixes label Dec 16, 2018
    @bombs-kim bombs-kim mannequin assigned docspython Dec 16, 2018
    @bombs-kim bombs-kim mannequin added the docs Documentation in the Doc dir label Dec 16, 2018
    @bombs-kim
    Copy link
    Mannequin Author

    bombs-kim mannequin commented Dec 16, 2018

    To elaborate, the docs simply says "Both the profile and cProfile modules provide the following functions... enable(), disable(), create_stats() ..."

    @asvetlov
    Copy link
    Contributor

    New changeset b912f93 by Andrew Svetlov (Beomsoo Kim) in branch 'master':
    bpo-35511: Trivial docs updates for profile and resource library modules. (GH-11124)
    b912f93

    @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.8 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @asvetlov