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

Update to pipeline schema doc #1045 #1926

Merged
merged 5 commits into from
Nov 2, 2022

Conversation

jenmuell
Copy link
Contributor

Update to pipeline schema doc based on nf-core/website#1045

I work on an update of the pipeline schema doc:

  • 2 sections for adding parameters and updating parameters with the graphical interface
  • 1 section about the nf-core schema docs command

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

nf-core#1045
- update on the pipeline schema documentation for updates and changes
- added a paragraph for `nextflow schema docs`
@jenmuell jenmuell requested a review from ewels October 11, 2022 12:17
@jenmuell jenmuell self-assigned this Oct 11, 2022
@github-actions
Copy link
Contributor

This PR is against the master branch ❌

  • Do not close this PR
  • Click Edit and change the base to dev
  • This CI test will remain failed until you push a new commit

Hi @jenmuell,

It looks like this pull-request is has been made against the jenmuell/tools master branch.
The master branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to master are only allowed if they come from the jenmuell/tools dev branch.

You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.
Note that even after this, the test will continue to show as failing until you push a new commit.

Thanks again for your contribution!

@jenmuell jenmuell changed the base branch from master to dev October 11, 2022 12:18
@codecov
Copy link

codecov bot commented Oct 11, 2022

Codecov Report

Merging #1926 (c342220) into dev (6bf8f30) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #1926   +/-   ##
=======================================
  Coverage   62.01%   62.01%           
=======================================
  Files          42       42           
  Lines        4862     4862           
=======================================
  Hits         3015     3015           
  Misses       1847     1847           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

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

Thanks @jenmuell!
Only some small style suggestions :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Júlia Mir Pedrol <mirp.julia@gmail.com>
@mirpedrol
Copy link
Member

@nf-core-bot fix linting

@mirpedrol mirpedrol merged commit 9c1472e into nf-core:dev Nov 2, 2022
@jenmuell jenmuell deleted the update_to_pipeline_schema_doc branch March 28, 2023 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Parameter schema
3 participants