Fixed broken deploy script due to multiline configuration docs #7385
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
|
r? @phansch (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
r? @flip1995 Could you maybe review this PR 🙃 |
xFrednet
commented
Jun 20, 2021
| @@ -91,7 +91,7 @@ def parse_configs(path): | |||
| contents = fp.read() | |||
|
|
|||
| match = re.search(conf_re, contents) | |||
| confvars = re.findall(confvar_re, match.group(1)) | |||
| confvars = re.findall(confvar_re, match.group(0)) | |||
There was a problem hiding this comment.
This used to reference the second group as the previous regex also match with the macro_rules! define_Conf { part.
|
@bors r+ Thanks! (I really have to make some time to get the metadata collector through) |
|
📌 Commit 96a9786 has been approved by |
|
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
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 deploy script on master currently runs into an error (See log) due to the new configuration documentation added in #7299. The current documentation collection for the configuration macro sadly doesn't support multiline doc comments. This will be changes in the future with the new metadata collector tracked in #7172 For now we have to use
<br>inside doc comments to add paragraphs.This PR restricts
define_Conf!macro to single lines and adds a comment explaining the reasoning behind it. It also adjusted the actual document parsing to fix a bug. (The parsing was automatically stopping on the first curly bracket, even if it was part of a doc comment).changelog: none