Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fixes #18088: Generate documentation for the stdlib #3167

Merged
merged 1 commit into from
Aug 14, 2020
Merged

Fixes #18088: Generate documentation for the stdlib #3167

merged 1 commit into from
Aug 14, 2020

Conversation

amousset
Copy link
Member

@amousset amousset commented Aug 7, 2020

@amousset amousset requested a review from gpoblon August 7, 2020 16:08
@amousset amousset force-pushed the arch_18088/generate_documentation_for_the_stdlib branch from 7e1b5fd to e5634f0 Compare August 7, 2020 16:10
@amousset
Copy link
Member Author

amousset commented Aug 7, 2020

Commit modified

@amousset amousset added the WIP Use that label for a Work In Progress PR that must not be merged yet label Aug 7, 2020
@amousset
Copy link
Member Author

amousset commented Aug 7, 2020

Do not merge, the new stdlib breaks the parser

@amousset
Copy link
Member Author

amousset commented Aug 7, 2020

PR updated with a new commit

@amousset amousset force-pushed the arch_18088/generate_documentation_for_the_stdlib branch from 69b970b to e5634f0 Compare August 7, 2020 19:25
gpoblon
gpoblon reviewed Aug 8, 2020
View reviewed changes
rudder-lang/tools/rudderc-prod.conf Outdated Show resolved Hide resolved
rudder-lang/src/generators/documentation.rs Outdated Show resolved Hide resolved
@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

amousset
amousset commented Aug 12, 2020
View reviewed changes
rudder-lang/libs/std/dsc.rl Outdated Show resolved Hide resolved
@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

@amousset
Copy link
Member Author

PR updated with a new commit

gpoblon
gpoblon reviewed Aug 14, 2020
View reviewed changes
rudder-lang/tools/generate_lib

# Parse metadata tag line
match = re.match(
r"^\s*#\s*@(\w+)\s*(([a-zA-Z0-9_]+)?\s+(.*?)|.*?)\s*$",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

named parameters (if possible) would make it easier to understand

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i have to admit I just took the regexes from the ncf library

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but I can try to improve it indeed.

gpoblon
gpoblon approved these changes Aug 14, 2020
View reviewed changes
Copy link
Contributor

@gpoblon gpoblon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean work with the new lib and the markdown generator,

@Normation-Quality-Assistant
Copy link
Contributor

This PR is not mergeable to upper versions.
Since it is "Ready for merge" you must merge it by yourself using the following command:
rudder-dev merge https://github.com/Normation/rudder/pull/3167
-- Your faithful QA
Kant merge: "Live your life as though your every act were to become a universal law."
(https://ci.normation.com/jenkins/job/merge-accepted-pr/28805/console)

@amousset
Copy link
Member Author

OK, squash merging this PR

1 similar comment
@amousset
Copy link
Member Author

OK, squash merging this PR

@amousset amousset force-pushed the arch_18088/generate_documentation_for_the_stdlib branch from e2d53d5 to 55bcaca Compare August 14, 2020 09:58
@amousset
Copy link
Member Author

OK, merging this PR

@amousset amousset merged commit 55bcaca into Normation:master Aug 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gpoblon gpoblon gpoblon approved these changes

Assignees
No one assigned
Labels
qa: Can't merge Trigger test WIP Use that label for a Work In Progress PR that must not be merged yet
Projects
None yet
Milestone
No milestone
3 participants
@amousset @Normation-Quality-Assistant @gpoblon