sqlalchemy / sqlalchemy/alembic
add doc section to autogenerate talking about include_object use cases
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.4k
- Forks
- 375
- PR merge metrics
- No merged PRs in 30d
Description
Migrated issue, originally created by Michael Bayer (@zzzeek)
e.g. to http://alembic.readthedocs.org/en/latest/autogenerate.html including:
-
using Tables for views
-
working around constraint names that are truncated
add a link from the current include_object docstring (which isn't in sphinx search since it's paramref)
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 autogenerate documentation page and the current include_object docstring. Add the requested use cases for using Tables for views and handling truncated constraint names, then link the docstring to the new section. Done means the section is searchable and the link and examples render correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100