Allow to build RST content strings #109
Merged
Conversation
This file contains hidden or 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
OskarStark
reviewed
Jul 9, 2021
src/BuildConfig.php
Outdated
| @@ -30,6 +30,8 @@ class BuildConfig | |||
| private $subdirectoryToBuild; | |||
| private $excludedPaths; | |||
| private $fileFinder; | |||
| private $isContentAString; | |||
There was a problem hiding this comment.
Suggested change
| private $isContentAString; | |
| private $contentIsString; |
?
Merged
javiereguiluz
added a commit
that referenced
this pull request
Jul 15, 2021
This PR was merged into the main branch. Discussion ---------- Don't output errors This change is needed because otherwise, this happens: https://github.com/doctrine/rst-parser/blob/54024026d64fff84de645537015e30709a123ab1/lib/ErrorManager.php#L27-L29 This `echo` outputs the errors to the console, which is not that bad ... but also to the webpage contents (e.g. when using #109 to parse RST blog posts). We manage the build results and the errors explicitly, so we don't need this for Symfony docs. Thanks! Commits ------- e8e6ee2 Don't output errors
javiereguiluz
force-pushed
the
build_string
branch
from
e320c48 to
fd965cc
Compare
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.
The common use case is to build all the RST contents stored in some dir. However, sometimes you need to build just the contents of a single file or a string. For example we need this for symfony.com, where many blog posts are written as RST contents.
This PR adds a new
buildString(string $contents): BuildResultcontent to complement the currentbuild(BuildConfig $config): BuildResultmethod.I had to add some config options and methods ... please tell me what you think about their naming. Thanks!