Improve wording used in functions related to context managers
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
Based on Python docs, we should talk about with statement and not about context managers in our documentation.
Relevant functions:
Session.__init()__Session.close()Session.initiate()Session.abort()
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
Locate the documentation for Session.init(), Session.close(), Session.initiate(), and Session.abort(). Compare their wording with the Python documentation for the with statement, then update references that describe context managers. Done means the relevant documentation consistently uses the requested with-statement terminology.
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
- 48/100