Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Command naming consistency

See original GitHub issue

Unify naming without breaking backwards compatibility.

more intuitive (e.g. cml <noun> <verb> [options])
easier to explain
better correspondence with (to be) documented use cases

Current	Proposed
`cml ci`	`cml ci [setup]`
`cml pr`	`cml pr [create] [{--merge,--rebase,--squash}]`
	`cml pr {create <file...>,close [<number>]}`
	`cml pr {merge} [{--no-ff(?),--ff(?),--rebase,--squash}]`
`cml publish [--native] [--type=file]`	hide
`cml runner`	`cml runner [launch]`
`cml send-comment`	`cml {comment,report} {create,update}`
	`cml {comment,report} watch [--update]`
`cml send-github-check`	`cml check {create,update}`
`cml tensorboard-dev`	`cml tensorboard-dev [publish]`
`cml rerun-workflow`	`cml workflow {rerun,stop}`

Issue Analytics

State:
Created 2 years ago
Reactions:3
Comments:33 (33 by maintainers)

Top GitHub Comments

15reactions

casperdclcommented, Jun 20, 2022

I see 3 points of contention, can vote with emojis:

cml runner a) [launch] 👍 b) [start] 👀
cml tensorboard-dev a) [publish] 😄 b) [start] 🎉
cml workflow a) rerun ❤️ b) restart 🚀

3reactions

DavidGOrtegacommented, Oct 13, 2021

attachment or image should be consistent with the others 👎

Im not a super fan of publish but attachment or image is… really bad 😁

Top Results From Across the Web

Naming convention (programming) - Wikipedia

In computer programming, a naming convention is a set of rules for choosing the character sequence to be used for identifiers which denote...

CL command names - IBM i

An occasional convention is to use single letters in the middle of the command name (typically between commonly used three-character verbs and objects),...

The Importance of Consistent Data Naming Conventions

Using descriptive, consistent naming conventions is important and should not go overlooked. Variability and inconsistencies often lead to ...

Naming Convention — 9 Basic Rules for any Piece of Code

Rule #1 — Consistency All 3 names of the above methods are the same and can be interpreted as the same operation. It...

Coding best practices

Consistency and readability are key ideas that should be utilized in the naming of variables. Regardless of how you choose to name your...