Docs: remove reference to Key
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Open docs/terminology.rst and find the "Assisted Builder" section containing the DB = Key('DB') example. Check the current library API and documentation for the replacement pattern, then update that reference and verify the terminology page no longer directs readers to the removed Key usage.
Written by the indexing model from the issue text.
Description
Hiya,
I understand that Key has been removed from the library.
This took me a bit of headscratching to figure out! I was following https://github.com/alecthomas/injector/blob/master/docs/terminology.rst
Github won't let me easily link the line number, but it's under "Assisted Builder" and the line looks like this: >>> DB = Key('DB')
Could we get the docs updated with the new way of doing things?
I'm new to this library, so if you'd like me to PR it, then I'll need guidance on the correct content.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 94
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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 python-injector/injector
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
python-injector/injector#317 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
python-injector/injector#298 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
python-injector/injector#297 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
python-injector/injector#267 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
python-injector/injector#258 · 3 comments ·
All issues in python-injector/injector
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
zostera/django-bootstrap4#894 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3276 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zilliztech/memsearch#759 ·