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

[Enhancement] Strip paths from metadata comments #24456

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

elpekenin
Copy link
Contributor

@elpekenin elpekenin commented Oct 2, 2024

Description

As per @sigprof and @tzarc discussion on discord a few weeks ago

NOTE: Does still show "fake" arguments, like --flag False (user would have used just --flag)
However, i dont think there is a great way of handling it... We may use sys.argv[1:] or the like, but that would lose some extra context/information, such as the parsing (default values? type casting?) performed by milc, while the current approach does show relevant info: what the code "sees"... Im open to other alternatives about this, anyway

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@github-actions github-actions bot added python cli qmk cli command labels Oct 2, 2024
@drashna drashna requested a review from a team October 3, 2024 11:07
@tzarc
Copy link
Member

tzarc commented Oct 6, 2024

Given your comment in the description about command arguments, perhaps just listing configuration items and associated value in a table?

I don't think there's a particularly large reason to keep the command listed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli qmk cli command python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants