-
Notifications
You must be signed in to change notification settings - Fork 39
Fix a broken link and build warning #268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
* apply vale statements in config.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one part where I think you need to shift the Vale off/on outside the PHP method/class declarations as the content isn't showing.
docs/plugins/config.rst
Outdated
| .. php:method:: getType() | ||
| .. vale off |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked my changes, and it's the same with the live website. So they all actually broken.
Maybe let's just remove the vale here. Might give some errors, but it's because of the code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is weird. I removed the vale statements completely from here, but the result is still the same as your screenshot.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not familiar with php.
But can you confirm that the whole block is php code block?
.. php:class:: Mautic\CoreBundle\Event\RouteEvent
.. php:method:: getType()
:returns: The :ref:`route firewall<plugins/config:Routing firewalls>` for the given route collection.
:returntype: string
.. php:method:: getCollection()
:returns: Returns a RouteCollection object that can be used to manually define custom routes.
:returntype: \\Symfony\\Component\\Routing\\RouteCollection
.. php:method:: addRoutes(string $path)
Load custom routes through a resource file such as yaml or XML.
:param string $path: Path to the resource file. For example, ``@FMElfinderBundle/Resources/config/routing.yaml``.
:returntype: voidThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If so, I think I know where it's gone wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed the vale off/on. I'm not sure how these RST syntax should be rendered on the site, though. I'm asking confirmation from Rahul on Slack.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "rendering problem" has been fixed in #269. 👍🏼
|
@RCheesley I've removed all vale statements. They don't seem to yell here. This PR now only holds below changes:
So I think this is good to go. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GTG!
|
Does this also need fixing in other branches @adiati98 ? |
|
I think we only have one branch in developer docs? |

Description
This PR holds below changes:
config.rst.Linked issue
Closes #267
Screenshots or screen recordings