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

Issue #1558: Clarify documentation for the --ignore option #1584

Merged
merged 2 commits into from
Nov 13, 2021

Conversation

MatthiasZepper
Copy link
Collaborator

  • This comment contains a description of changes (with reason)

This pull request updates docs/usage.md to clarify the section on the --ignore option. The documentation now also briefly mentions the --ignore-symlinks flag, which was introduced in MultiQC v1.6, but not yet covered.

  • CHANGELOG.md has been updated

Not applicable

…d documentation for the --ignore-symlinks flag.
@MatthiasZepper MatthiasZepper linked an issue Nov 12, 2021 that may be closed by this pull request
Copy link
Member

@ewels ewels left a comment

Choose a reason for hiding this comment

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

Thanks! Sorry, giving you a docs task was a bit mean as I have my own idiosyncrasies that I usually stick to..

  • One sentence per line
    • GitHub inserts newlines after a single line break, but most markdown rendering engines (including the MultiQC and nf-core websites) ignore them.
    • Having shorter lines makes the diffs easier to read when editing docs
    • Using sentences as natural line breaks (rather than a character width) makes editing easier and diffs clearer.
  • I usually draw attention to "gotchas" like the quotes thing here with blockquotes, then use CSS to make these highlighted. This is mostly because Markdown doesn't have (easy) ways to have custom styles for this like RST (though there are extensions). It works fine.

Otherwise great!

docs/usage.md Outdated Show resolved Hide resolved
@ewels ewels enabled auto-merge November 13, 2021 20:01
@ewels ewels merged commit f184b03 into MultiQC:master Nov 13, 2021
@MatthiasZepper MatthiasZepper deleted the issue1558_ignore_documentation branch January 3, 2022 10:01
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.

--ignore does not work properly
2 participants