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

fix: docs: Modify generate-lotus-cli.py to ignoring aliases. #11535

Merged
merged 2 commits into from
Dec 18, 2023

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented Dec 18, 2023

Proposed Changes

Modify the generate-lotus-cli.py script to generate documentation for the primary sub-commands, ignoring any aliases. Previously the script would fail to generate CLI-documentation for commands with aliases, so we only would get an empty output: https://github.com/filecoin-project/lotus/blob/master/documentation/en/cli-lotus.md#lotus-state-sector-sector-info

Also add lotus-provider to the CLI-documentation generation script.

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
  • New features have usage guidelines and / or documentation updates in
  • Tests exist for new functionality or change in behavior
  • CI is green

Modify generate-lotus-cli.py to ignoring aliases.
@rjan90 rjan90 requested a review from a team as a code owner December 18, 2023 14:45
Make docsgen-cli
documentation/en/cli-lotus-provider.md Show resolved Hide resolved
documentation/en/cli-lotus-provider.md Show resolved Hide resolved
documentation/en/cli-lotus-provider.md Show resolved Hide resolved
documentation/en/cli-lotus-provider.md Show resolved Hide resolved
@snadrus snadrus merged commit 62fe670 into master Dec 18, 2023
89 checks passed
@snadrus snadrus deleted the lp-generate-cli-docs branch December 18, 2023 16:51
rjan90 pushed a commit that referenced this pull request Jan 4, 2024
fix: docs: Modify generate-lotus-cli.py to ignoring aliases.
rjan90 pushed a commit that referenced this pull request Jan 4, 2024
fix: docs: Modify generate-lotus-cli.py to ignoring aliases.
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.

None yet

2 participants