python-trio / python-trio/trio
Replace SIGHUP example in docs with one that doesn't assume arcane Unix knowledge
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
Currently in our docs for open_signal_receiver, we have an example of catching SIGHUP and using it to reload the application configuration. While talking to @wgwz today re: https://github.com/python-trio/snekomatic/pull/41, I discovered that this example is maybe not so great, because readers who aren't already steeped in Unix traditions will have no idea what the heck a SIGHUP is supposed to be.
Using SIGTERM in the example would probably be less distracting!
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 with the linked open_signal_receiver section in the Trio documentation and review the existing SIGHUP configuration-reload example. Replace the SIGHUP example with the proposed SIGTERM version, ensuring the documentation no longer assumes readers understand SIGHUP or Unix traditions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100