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

Minor documentation fixes #92

Merged
merged 1 commit into from
May 28, 2024
Merged

Minor documentation fixes #92

merged 1 commit into from
May 28, 2024

Conversation

johandahlberg
Copy link
Collaborator

@johandahlberg johandahlberg commented May 28, 2024 •
edited
Loading

Minor updates to the docs to fix some errors @ambarrio found.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/pixelator branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@johandahlberg johandahlberg requested a review from fbdtemme May 28, 2024 06:20
@github-actions GitHub Actions
Copy link

github-actions bot commented May 28, 2024 •
edited
Loading

nf-core lint overall result: Failed ❌

Posted for pipeline commit f1b288c

+| ✅ 197 tests passed       |+
#| ❔   5 tests were ignored |#
!| ❗   5 tests had warnings |!
-| ❌   2 tests failed       |-

❌ Test failures:

  • files_unchanged - .github/workflows/linting_comment.yml does not match the template
  • files_unchanged - .github/workflows/linting.yml does not match the template

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 1.1.0
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • nfcore_yml - nf-core version not set in .nf-core.yml

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-05-28 06:20:34

@johandahlberg johandahlberg merged commit db761d1 into nf-core:dev May 28, 2024
3 of 4 checks passed
@fbdtemme fbdtemme deleted the chore/minor-doc-fixes branch May 29, 2024 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fbdtemme fbdtemme fbdtemme approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@johandahlberg @fbdtemme