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

CLI/Docs: Fix the format commands' name #13668

Merged
merged 1 commit into from Jul 23, 2021

Conversation

Erovia
Copy link
Member

@Erovia Erovia commented Jul 23, 2021

Description

PR #13296 changed the name of the cformat and pyformat commands to
format-c and format-py respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new format-text subcommand, introduced
in the same PR.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (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).

PR qmk#13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
Comment on lines +321 to +322
Every text file in the repository needs to have Unix (LF) line ending.
If you are working on **Windows**, you must ensure that line endings are corrected in order to get your PRs merged.
Copy link
Member

Choose a reason for hiding this comment

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

👍👍👍

@Erovia Erovia merged commit fdcea06 into qmk:develop Jul 23, 2021
@Erovia Erovia deleted the docs/format_commands branch July 23, 2021 20:41
cadusk pushed a commit to cadusk/qmk_firmware that referenced this pull request Jul 24, 2021
* qmk/develop: (33 commits)
  [Keyboard] Add Keychron Q1 (qmk#13397)
  [Keymap] add kinesis/keymaps/jwon (qmk#13618)
  [Keyboard] Dharma (qmk#13663)
  feature: Add swap hands support for sofle keyboard. (qmk#13654)
  Fix up xd002 rgb keymaps (qmk#13685)
  Avoid LTO conficts on arm_atsam (qmk#13676)
  [Keyboard] Reduce compile size for dz60rgb v2.1 (qmk#13680)
  [Keyboard] Fix type on pandora via keymap (qmk#13681)
  Remove deprecated callbacks for encoders and dip switches (qmk#13404)
  [Keyboard] Quick hack to fix Astro65 board (qmk#13665)
  [Keyboard] Added Compound keyboard support (qmk#12942)
  Disables rgblight twinkle by default. (qmk#13677)
  [Keyboard] Fix split matrix for sekigon grs 70ec (qmk#13672)
  [Keyboard] Fix matrix delay on Drop boards (qmk#13671)
  [Keyboard] Disable console by default on all Keebio boards (qmk#13649)
  CLI/Docs: Fix the format commands' name (qmk#13668)
  [Keyboard] Enable LTO by default on BastardKB Scylla (qmk#13664)
  [Keyboard] Fix symmetric70_proto build break on develop branch (qmk#13667)
  [Keyboard] Remove broken, unmaintained converter/ibm_5291 (qmk#13658)
  [Keyboard] Add model-v keyboard (qmk#13643)
  ...
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
PR qmk#13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants