sqlalchemy / sqlalchemy/alembic

Document version_locations can contain resource specs

Open
#256 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
4.4k
Forks
375
PR merge metrics
No merged PRs in 30d

Description

Migrated issue, originally created by Wichert Akkerman (@wichert)

I was about to create a patch to support use of resource specs in version_locations, only to discover in the code that that is already supported. This should probably be mentioned in the documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation for version_locations and read the existing explanation of its accepted values. Document that resource specs are supported, then verify the documentation clearly states this behavior and matches the current implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, sqlalchemy
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.