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.

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

Deduplicate the execute step documentation #3415

Merged
merged 8 commits into from
Feb 19, 2025
Merged

Conversation

mcasquer
Copy link
Collaborator

@mcasquer mcasquer commented Dec 10, 2024

The documentation about the execute is duplicated between
the specifications and the plugins sections. Lets put all
the info in the plugins section.

Pull Request Checklist

  • write the documentation
  • update the specification
  • adjust plugin docstring

@mcasquer mcasquer force-pushed the execute_deduplication branch 2 times, most recently from c725084 to d8358ea Compare December 10, 2024 09:38
@mcasquer mcasquer marked this pull request as ready for review December 10, 2024 09:42
@mcasquer mcasquer force-pushed the execute_deduplication branch from d8358ea to 31551a7 Compare January 28, 2025 08:52
@mcasquer mcasquer requested a review from martinhoyer as a code owner January 28, 2025 08:52
@mcasquer mcasquer force-pushed the execute_deduplication branch from 05ad976 to 2382ef9 Compare January 29, 2025 13:51
@happz happz added the documentation Improvements or additions to documentation label Jan 30, 2025
@happz happz added this to the 1.43 milestone Jan 30, 2025
Copy link
Collaborator

@therazix therazix left a comment

Choose a reason for hiding this comment

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

Looks good. But shouldn't we keep the references in the text, just as they are in the specification? Or is there a reason for leaving them out?

@mcasquer
Copy link
Collaborator Author

mcasquer commented Feb 7, 2025

Looks good. But shouldn't we keep the references in the text, just as they are in the specification? Or is there a reason for leaving them out?

Thanks for the heads-up, I don't know why I thought the refs won't work 😅, adding them back

@mcasquer mcasquer force-pushed the execute_deduplication branch from 2382ef9 to 46f809d Compare February 7, 2025 21:48
@psss psss changed the title Deduplicates execute documentation Deduplicate the execute step documentation Feb 12, 2025
@mcasquer mcasquer force-pushed the execute_deduplication branch 3 times, most recently from 1b9ce42 to 299a4ce Compare February 18, 2025 07:49
@mcasquer
Copy link
Collaborator Author

PR updated with information removed from the specs, could this be reviewed again? Thanks !

The documentation about the execute is duplicated between
the specifications and the plugins sections. Lets put all
the info in the plugins section.

Signed-off-by: mcasquer <[email protected]>
@lukaszachy lukaszachy force-pushed the execute_deduplication branch from 299a4ce to ae43a5f Compare February 19, 2025 16:15
@lukaszachy lukaszachy merged commit 5c666dc into main Feb 19, 2025
6 of 21 checks passed
@lukaszachy lukaszachy deleted the execute_deduplication branch February 19, 2025 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants