Transform examples in docs into included source files
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Read the svcs docs examples linked in the issue and review the related discussion in #817 to understand the proposed pattern. Then inspect the documentation examples in structlog and identify which source snippets should become included files; done means those examples are verifiable while remaining included in the docs. Pull request #826 is already open, so this work is underway.
Written by the indexing model from the issue text.
Description
A successful examples of this is https://github.com/hynek/svcs/tree/main/docs/examples
We’ve had the case of errors in recipes before and we’ve hit a similar dilemma in #817 again. Source code that isn’t a doctest should still be somehow verifiable.
cc @sirosen
- Dominant language
- Python
- Stars
- 5k
- Forks
- 302
- Avg merge
- 17m
- Merged PRs (30d)
- 4
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from hynek/structlog
-
bind_contextvars is not thread-safe?Possibly taken @nosmile99 claimed this 1 day ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 5/5 Over a week Newbie friendliness 38/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
waiting for feedback
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
`CallsiteParameterAdder` use `additional_ignores` for foreign eventsPossibly taken @hynek claimed this 148 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 25/100
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
sergey-miryanov/gcmon#230 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Azure-Samples/azure-search-openai-demo#3249 ·
Maintainers usually reply within 1 day
-
[BUG] Failed archive extraction deletes the dataset cachePossibly taken @dajiaohuang claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
alibaba/GraphScope#4674 ·