Skip to content

Update to tldr-lint v0.0.9 #5046

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
7 tasks done
owenvoke opened this issue Dec 23, 2020 · 2 comments · Fixed by #5082
Closed
7 tasks done

Update to tldr-lint v0.0.9 #5046

owenvoke opened this issue Dec 23, 2020 · 2 comments · Fixed by #5082
Labels
mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). tooling Helper tools, scripts and automated processes.

Comments

@owenvoke
Copy link
Member

owenvoke commented Dec 23, 2020

We currently can't update tldr-lint to v0.0.9 ( as we need to clean up some of the pages. The new release now does the following:

Currently when running tldr-lint pages/, it returns the following which needs to be resolved:

List of pages that need to be addressed
pages/common/arc.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/deemix.md:5: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/eva.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/fnm.md:5: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/glow.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/glow.md:4: TLDR017 Information link should be surrounded with angle brackets
pages/common/ipython.md:4: TLDR017 Information link should be surrounded with angle brackets
pages/common/jq.md:0: TLDR019 Page should only include a maximum of 8 examples
pages/common/kotlin.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/nativefier.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/nc.md:0: TLDR019 Page should only include a maximum of 8 examples
pages/common/nmap.md:0: TLDR019 Page should only include a maximum of 8 examples
pages/common/notmuch.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/common/tar.md:0: TLDR019 Page should only include a maximum of 8 examples
Error: Parse error on line 5:
...irshcmdref.html>.> NOTE: 'guest_id' can...
----------------------^
Expecting 'INFORMATION_LINK', got 'DESCRIPTION_LINE'
pages/linux/efibootmgr.md:4: TLDR017 Information link should be surrounded with angle brackets
pages/linux/homeshick.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/linux/netselect.md:4: TLDR004 Command descriptions should end in a period
pages/linux/rofi.md:4: TLDR016 Label for information link should be spelled exactly `More information: `
pages/linux/vgs.md:4: TLDR017 Information link should be surrounded with angle brackets
pages/linux/yetris.md:0: TLDR019 Page should only include a maximum of 8 examples
pages/osx/brew.md:0: TLDR019 Page should only include a maximum of 8 examples
pages/windows/choice.md:5: TLDR016 Label for information link should be spelled exactly `More information: `
pages/windows/shutdown.md:0: TLDR019 Page should only include a maximum of 8 examples

#5050 resolves most of these, and then the only other thing would be to decide what to do with the pages that are over the 8-example limit (TLDR019). These are the following:

@owenvoke owenvoke added mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). tooling Helper tools, scripts and automated processes. labels Dec 23, 2020
@owenvoke
Copy link
Member Author

We may also need to check any of the translations that exist for these pages, to ensure that they follow the updates (although we can't run the linter against them).

@bl-ue
Copy link
Contributor

bl-ue commented Jan 4, 2021

@owenvoke all of the 9-example pages are trimmed to 8! Go ahead and proceed!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). tooling Helper tools, scripts and automated processes.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants