Improve documentation about traversal behavior in plone.api.content.get
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 101
- Forks
- 62
- Avg merge
- 15h 15m
- Merged PRs (30d)
- 1
Description
I just solved an intricate bug because I didn't now that plone.api.content.get uses traversal. Since you give a path as an argument, I wasn't expecting traversal in this context.
Inspired by:
plone.api comes with cookbook-like documentation and step-by-step instructions for doing common development tasks in Plone. Recipes try to assume the user does not have extensive knowledge about Plone internals.
I suggest to complement plone.api.content.get's documentation explaining about acquisition effect and, if possible, with examples of what can happen because of acquisition.
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 get-content-object section in docs/content.rst and compare it with plone.api.content.get in src/plone/api/content.py. Read the linked Plone traversal and acquisition documentation for context. Done means the API documentation explains that get uses traversal and acquisition, with examples of the resulting behavior where possible.
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
- Clearly specified
- Newbie friendliness
- 35/100