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

style(docs): fix linter errors for auto-generated commands #4358

Merged
merged 4 commits into from
Sep 14, 2023

Conversation

mr-cal
Copy link
Collaborator

@mr-cal mr-cal commented Sep 7, 2023

  • Have you followed the guidelines for contributing?
  • Have you signed the CLA?
  • Have you successfully run make lint?
  • Have you successfully run pytest tests/unit?

Autogenerated documentation needs to be created before running the linters.

You should be able to reproduce this problem on main:

tox run -e build-docs
tox run -e lint-docs # fails on autogenerated commands

2 separate commits so this is a rebase-and-merge.

Autogenerated documentation needs to be created before
running the linters.

Signed-off-by: Callahan Kovacs <[email protected]>
@mr-cal mr-cal added the rebase label Sep 7, 2023
@mr-cal mr-cal requested review from lengau and tigarmo September 7, 2023 19:10
@codecov-commenter
Copy link

codecov-commenter commented Sep 7, 2023

Codecov Report

Merging #4358 (5cdd9a6) into main (c8e9b2e) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##             main    #4358      +/-   ##
==========================================
- Coverage   89.22%   89.21%   -0.01%     
==========================================
  Files         301      301              
  Lines       20688    20688              
==========================================
- Hits        18458    18457       -1     
- Misses       2230     2231       +1     
Files Changed Coverage Δ
snapcraft/commands/account.py 88.39% <ø> (ø)
snapcraft/commands/legacy.py 79.41% <ø> (ø)
snapcraft/commands/lint.py 100.00% <ø> (ø)
snapcraft/commands/manage.py 81.08% <ø> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@lengau lengau left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@mr-cal mr-cal requested review from tigarmo and removed request for tigarmo September 14, 2023 13:10
@mr-cal mr-cal merged commit 9680075 into main Sep 14, 2023
@mr-cal mr-cal deleted the doc-linter-warnings branch September 14, 2023 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants