DBAL-764: Provide a reference of the portable Column types and options #1993

Closed
doctrinebot opened this Issue Jan 4, 2014 · 7 comments

2 participants

@doctrinebot

Jira issue originally created by user fgm:

One difficulty I had with the existing documentation and tools for DBAL was the lack of a reference for what the valid values were (e.g. "notnull" instead of "not null").

See http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/schema-representation.html for example: some values are given, but there is no reference list, and anything put just in documentation would incur the risk of not remaining updated.

So I tried to guess-generate the information from the code, like this: https://gist.github.com/FGM/8261606 (also attached).

Unless an equivalent already exists somewhere, I think it could be useful to have something like this in upcoming releases.

@doctrinebot

Comment created by @deeky666:

Documentation supplied in PR: #502
Please give a shout if something is missing, wrong, arguable or what... :)

@doctrinebot

Comment created by fgm:

Glad to see so much information in your PR. Did you create it from scratch or was it available elsewhere ?

Also, since the project seems to have some difficulty keeping up with "guide"-type documentation vs code evolutions, wouldn't it be feasible to have most of this information be generated from code (or phpdoc), to have it be automatically maintained when code changes ?

@doctrinebot

Comment created by @deeky666:

[~fgm] I created it from scratch as you requested in this ticket. We are aware the DBAL documentation isn't in the best shape, but we are working on it step by step. Please bare with us if it takes some time to catch up all the missing things.
An API documentation is always autogenerated and published automatically on the Doctrine website: http://www.doctrine-project.org/api/dbal/2.4/index.html

@doctrinebot

Comment created by fgm:

OK, i was afraid it was somewhere and I had missed it. Beyond that, don't you think it would be a good idea to have such lists of information be maintained as phpdoc rather than in the doc sources, and exported instead of being types. This would allow such commands as the one I had imagined (obviously better done).

@doctrinebot

Comment created by @doctrinebot:

A related Github Pull-Request [GH-502] was closed:
#502

@doctrinebot

Comment created by @deeky666:

Fixed in commit: 6adc9ee

@doctrinebot

Issue was closed with resolution "Fixed"

@deeky666 deeky666 was assigned by doctrinebot Dec 7, 2015
@doctrinebot doctrinebot added this to the 2.5 milestone Dec 7, 2015
@doctrinebot doctrinebot closed this Dec 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment