Wrong or missing reference on sqlalchemy.orm.properties.ColumnProperty

Issue #3553 closed
Maurice Schleußinger created an issue

In the current docs:

Both sqlalchemy.orm.properties.ColumnProperty and sqlalchemy.orm.properties.RelationshipProperty claim to have sqlalchemy.orm.interfaces.StrategizedProperty as base class (see http://docs.sqlalchemy.org/en/latest/orm/internals.html#sqlalchemy.orm.properties.ColumnProperty).

However sqlalchemy.orm.interfaces.StrategizedProperty is neither linked nor to be found with the search: http://docs.sqlalchemy.org/en/latest/search.html?q=sqlalchemy.orm.interfaces.StrategizedProperty&check_keywords=yes&area=default

Comments (1)

  1. Mike Bayer repo owner

    So, there are hundreds of links in the documentation that are "broken", where by "broken" we mean here that Sphinx wants to make a hyperlink out of them but the target object isn't in the index, so you get a flat text label in the output instead.

    Volunteers who want to help with this via pull requests are very welcome to help out - just run "make html" in docs/build, pick any ten or twenty errors (we set the sphinx config to complain about all of them), and start repairing references and/or adding missing classes. This is a much bigger issue than this one issue number and there's not much point to having a giant "fix all the broken links" issue, because this issue will almost always be open as it is very easy for more broken links to find their way into the docs (and some are unavoidable).

    At the same time, the "ORM internals" section doesn't aim to publish docstrings for the entire source code of SQLAlchemy. StrategizedProperty and its further hierarchy are fine.

    So, feel free to send PRs on these, thanks!

  2. Log in to comment