[Docs] Fixing php-errors in the documentation #11619
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
probot-autolabeler
bot
added
the
Documentation
mamazu
commented
Jul 5, 2020
| @@ -31,7 +31,6 @@ Summary | |||
| interface: Sylius\Component\Promotion\Model\PromotionRuleInterface | |||
| controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController | |||
| repository: ~ | |||
| factory: Sylius\Component\Resource\Factory\Factory | |||
There was a problem hiding this comment.
This definition is there twice and yaml does not allow that.
mamazu
force-pushed
the
documentation_fixes
branch
from
253dcd7 to
bae25d9
Compare
vvasiloi
reviewed
Jul 6, 2020
docs/components_and_bundles/bundles/SyliusOrderBundle/processors.rst
Outdated
Show resolved
Hide resolved
lchrusciel
reviewed
Jul 6, 2020
docs/components_and_bundles/bundles/SyliusOrderBundle/processors.rst
Outdated
Show resolved
Hide resolved
|
Agreed. You usually want the composite one so I guess this is the best way to document it. |
|
@mamazu can you rebase to the master, please? |
In the documentation you usually want the composite processor so let's document it that way.
mamazu
force-pushed
the
documentation_fixes
branch
from
d004766 to
98422f1
Compare
|
Should be done now. I have also fixed on error that emerged from it. (Apparently sphinx checks if JSON data is parsable but not PHP.) |
lchrusciel
approved these changes
Jul 9, 2020
Comment on lines
40
to
41
| ) | ||
| { |
|
Thanks, @mamazu! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I am currently developing a documentation validator and added an
rstparser to it. Sylius was the trail run project and this is what I got out of it (fixes are done manually).One thing I am struggling with a little is the
...situation. Having...in a documentation is not very helpful, because to me it is saying: "You know what to fill in here". But then why write the documentation in the first place. (eg.SyliusOrderBundle/processors.rst) So I am not sure about that.