added composer info #5491
added composer info #5491
Conversation
| @@ -121,6 +121,13 @@ To use this component, add it as a dependency of the project: | |||
|
|
|||
| Running this command will also automatically download the Symfony | |||
| HttpFoundation component and install it under the ``vendor/`` directory. | |||
| A ``composer.json`` and a ``composer.lock`` file will be generated as well.:: | |||
There was a problem hiding this comment.
The trailing dot after well should be removed.
There was a problem hiding this comment.
The double :: "hack" can only be used when the code to highlight is PHP. In this case we need to highlight JSON, so you'll have to use a single :: and add a .. code-block:: directive.
|
@javiereguiluz done, can you please check? |
|
|
||
| .. code-block:: json | ||
|
|
||
| // composer.json |
There was a problem hiding this comment.
JSON does not have comments. So I think we should be avoid such constructs here.
There was a problem hiding this comment.
shall ii use .. code-block:: text instead?
There was a problem hiding this comment.
Well, I don't consider this as an issue with the syntax highlighting. It's just that someone will probably copy the code example and will then run into syntax errors because the example itself is no valid JSON.
I would rather change the example and maybe write an explanation below the code.
| "symfony/http-foundation": "^2.7" | ||
| } | ||
|
|
||
| ``The code block shows the content of the ``composer.json`` file (the actual |
There was a problem hiding this comment.
@xabbuh you mean the backticks here?
There was a problem hiding this comment.
@OskarStark Yeah, but they should only enclose the file name. So you should remove them from the beginning and the end of the paragraph now. :)
OskarStark
force-pushed
the
composer-info
branch
from
065533c to
5b8708a
Compare
|
done @xabbuh |
|
cool 👍 looks ready to be merged now |
|
👍! Merged it with a few minor changes (mostly fixing the syntax error in the code example) in ae14002 |
|
Thank you @wouterj |
No description provided.