ref: doctor +
#259
ref: doctor +
#259
Conversation
Link Check ReportThere were no links to check! |
|
@jorgeorpinel, could I ask you for a review? Also, there were some questions we didn't complete discussion of in #235, if you want we can complete it and make necessary updates in this PR. |
|
@jorgeorpinel, a friendly ping 🎅🏻 🎄 |
|
@jorgeorpinel, I'm merging this to make it available for users, but will be happy to hear suggestions for improvements. |
|
Sorry, this one fell through the cracks. Checking now 🙂 |
| { | ||
| "slug": "doctor", | ||
| "source": "doctor.md", | ||
| "label": "doctor" |
There was a problem hiding this comment.
The cmd ref changes are completely unrelated, right? Is the generator script running automatically whenever you change anything? Otherwise 🙏🏼 let's make separate PRs for ease of review in the future. Thanks
There was a problem hiding this comment.
Yes, they are unrelated. It doesn't run automatically, I do that manually. But, I can do that in separate PRs in future, sure.
There was a problem hiding this comment.
Thanks! Actually this PR was mostly about that now that I see haha. So I just changed the title 😬 and labels
jorgeorpinel
added
A: docs
| `--custom` option allows you to add custom metadata. Within `gto annotate` GTO | ||
| treats input as string, but you can edit artifacts.yaml to add arbitrary | ||
| information that fits yaml format, such as dict or list, or more complex | ||
| structures. |
There was a problem hiding this comment.
Doesn't seem important enough to be the only option explained directly in the Description. Probably adding to the Options section is enough?
| Note, that for local repos the `artifacts.yaml` is read from the workspace | ||
| without Git, so if you have uncommitted changes, they will be reflected in the | ||
| output. If you want to read from specific commit, you need to specify `--rev` | ||
| option. | ||
|
|
||
| You can also get annotation for specific versions (these are the same shortcuts |
There was a problem hiding this comment.
The first part is expected, I think. We can simplify this
| Note, that for local repos the `artifacts.yaml` is read from the workspace | |
| without Git, so if you have uncommitted changes, they will be reflected in the | |
| output. If you want to read from specific commit, you need to specify `--rev` | |
| option. | |
| You can also get annotation for specific versions (these are the same shortcuts | |
| If you want to read information from previous commits, specify a `--rev`. | |
| You can also get annotation for specific artifact versions (same shortcuts |
|
The changes to content/docs/gto/user-guide/mlem.md seem minimal, so I guess this PR was mostly about the cmd ref. The wording in the MLEM and DVC guides is confusing at times but that was an issue already. Hopefully we'll get to reviewing the grammar and trying to simplify the docs in general soon (let's plan it?) Thanks |
No description provided.