Format the possible version formats as a table #2302
Conversation
Note I: This syntax is supported by MarkdownExtra, which both getcomposer and github are using. Note II: This patch currently breaks the PDF, because pandoc does not like non-standard markdown tables. Ideas for fixing this appreciated. Note III: The idea for this patch came up a few weeks ago on IRC. We agreed back then that a table would be a good idea. Note IIII: This patch creates a stability section which opens the door for finally documenting how stability works in the composer docs.
|
While reviewing this PR, I figured that this section misses the documentation for OR between constraints (by separating them with a |
|
Does composer take care of precedence? |
|
@igorw Yes. If you combine |
|
Added docs for logical OR. |
| Name | Example | Description | ||
| -------------- | --------------------- | ----------- | ||
| Exact version | `1.0.2` | You can specify the exact version of a package. | ||
| Range | `>=1.0` `>=1.0,<2.0` `>=1.0,<1.1 | >=1.2` | By using comparison operators you can specify ranges of valid versions. Valid operators are `>`, `>=`, `<`, `<=`, `!=`. <br />You can define multiple ranges, separated by a comma, which will be treated as a **logical AND**. A pipe symbol `|` will be treated as a **logical OR**. <br />AND has higher precedence than OR. |
There was a problem hiding this comment.
should AND and OR really be documented in the Range constraint ? It could be used for any constraints, like for instance a OR between 2 wildcards
|
The new version of pandoc supports tables, but the longtable is too wide an goes over the edge. LaTeX wizard help needed to typeset basic table. |
|
After composer/getcomposer.org#55 is merged, this can be merged too. |
|
FWIW, here's what the PDF looks like: |
Format the possible version formats as a table
Format the possible version formats as a table
Note I: This syntax is supported by MarkdownExtra, which both getcomposer
and github are using.
Note II: This patch currently breaks the PDF, because pandoc does not like
non-standard markdown tables. Ideas for fixing this appreciated.
Note III: The idea for this patch came up a few weeks ago on IRC. We
agreed back then that a table would be a good idea.
Note IV: This patch creates a stability section which opens the door for
finally documenting how stability works in the composer docs.
With this patch applied to getcomposer, the result looks as follows: