Document that cprofile/profile only profile the main thread
Open
Nobody has claimed this yet.
3.7 (EOL)
3.8 (EOL)
3.9 (EOL)
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 38607 |
|---|---|
| Nosy | @ben-spiller |
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 = None
created_at = <Date 2019-10-27.18:18:43.156>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Document that cprofile/profile only profile the main thread'
updated_at = <Date 2019-10-27.18:18:43.156>
user = 'https://github.com/ben-spiller'
bugs.python.org fields:
activity = <Date 2019-10-27.18:18:43.156>
actor = 'benspiller'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-27.18:18:43.156>
creator = 'benspiller'
dependencies = []
files = []
hgrepos = []
issue_num = 38607
keywords = []
message_count = 1.0
messages = ['355492']
nosy_count = 2.0
nosy_names = ['docs@python', 'benspiller']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue38607'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for Python's cProfile and profile modules. Update it to state that these profilers only profile the main thread, and consider the work done when the limitation is clearly documented in the relevant user-facing reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100