Open command docs updation #538
Conversation
added sections for the open command describing the use cases and the changes to the open command , enabling the newer ways to use it
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -73,12 +73,22 @@ pieces list models | |||
| ``` | |||
|
|
|||
| ### `open` | |||
There was a problem hiding this comment.
The open command should be deprecated the e flag online works in the list command now
There was a problem hiding this comment.
Can we here say
###open (deprecated)
There was a problem hiding this comment.
addressed in the commit 36435e3 commit . also just to be sure , I think you meant #### open (deprecated) instead of ###open (deprecated) . if not , then I'll make the change exactly as suggested .
added deprecate alongside open in the docs as suggested .
|
|
||
| ```pieces config editor <editor_command>``` | ||
|
|
||
| #### NOTE : previous implementations of the open command are now deprecated. |
There was a problem hiding this comment.
Can we use either of the following rather than having NOTE:
Info Admonition. We use these all across the docs and its a nice way to show some extra info about something.
or
Just have the link be this: > Previous implementations of the open command are now deprecated.
There was a problem hiding this comment.
used the second suggestion in commit 94e8b7a
| ``` | ||
|
|
||
| ```-e``` is an optional flag . It Opens the asset in the configured external editor. Editor of choice can be configured using config command. |
There was a problem hiding this comment.
The e flag work in the list not in the open
It is list assets -e to open the asset in the editor
There was a problem hiding this comment.
got it . fixed the change in commit 52568c5
changes : - open is now ### not #### , i.e , h3 not h4 - open is now written with back ticks , retaining them as it used to earlier
- Removed Note implementation - Added the ```>``` version to address the note message from earlier .
earlier described in the open command , the editor opening is actually a flag of the list assets command , so that has been replaced , refactored and rewritten correctly .
| ### `open` | ||
| Opens an asset from a list or search. If only "open" is used, it opens the most recent asset. | ||
| ### `open` (deprecated) | ||
| Opens an asset from a list or search. If only "open" is used, it opens the most recent asset. This also creates a link to the asset's code. | ||
|
|
||
| ```bash | ||
| pieces open [ITEM_INDEX] |
There was a problem hiding this comment.
Can we here give some examples on the editor_command?
I am not sure what is the editor_command means here in that context you can say eg: code to open vs code or subl to open sublime etc.....
There was a problem hiding this comment.
addressed in 71304ba commit
|
|
||
| ```bash | ||
| pieces open [ITEM_INDEX] | ||
| ``` | ||
|
|
||
| ##### Editor Configuration: |
There was a problem hiding this comment.
If you could also update this to be an h4 that would be great!
There was a problem hiding this comment.
yup , that should have always been h4 , apologies for the typo , fixed in commit 9e734b5
added a few examples of how to setup and work with the editor_command , including code , vim , sublime , emacs , nano etc .
turned the editor config from h5 to h4
Description
Updated the documentation to correctly reflect the changes in the open command implementation
Changes
Objective