tengqm commented on code in PR #5840:
URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881164099
##########
docs/cli.md:
##########
@@ -64,54 +68,60 @@ The general structure for running commands with the
Gravitino CLI is `gcli entit
-x,--index display index information
-z,--provider <arg> provider one of hadoop, hive, mysql, postgres,
iceberg, kafka
- ```
+```
-## Commands
+## Commands Types
The following commands are used for entity management:
-- list: List available entities
-- details: Show detailed information about an entity
-- create: Create a new entity
-- delete: Delete an existing entity
-- update: Update an existing entity
-- set: Set a property on an entity
-- remove: Remove a property from an entity
-- properties: Display an entities properties
+- `create`: Create a new entity
+- `delete`: Delete an existing entity
+- `details`: Show detailed information about an entity
+- `list`: List available entities
+- `properties`: Display an entity's properties
+- `remove`: Remove a property from an entity
+- `set`: Set a property on an entity
+- `update`: Update an existing entity
Review Comment:
As I have responded in another review comment. When we don't have a
consensus on the
ordering of things, the best way to do it is to sort them in alphabetic
order.
Why? Every people may have a different opinion on the definition of "logical
grouping".
For example, why the first entry should be `list`? What am I doing this if I
haven't
created something? Why `delete` comes before `update`?
The main problem of this "logical grouping" is about predictability. There
will never
be a consensus on the correct/golden ordering.
With that, I'm strongly against it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
