docs: API auto-mentioning in docs (#910)#1305
Conversation
|
There is one thing: I don't know whether I should consider the proposed by CodeClimate "Cognitive Complexity" issue or not due to the fact that the commandLinker has the same complexity and it was in the production already. |
|
|
||
| ```dvc | ||
| $ dvc import https://github.com/example/registry \ | ||
| images/faces/ |
There was a problem hiding this comment.
same here - not sure what's going on
CC is too aggressive and we try to fix those issue, but it's not a requirement - especially complexity and number of lines of code |
|
Deployed a preview (it does not happen automatically on forks, usually we use branches) - https://dvc-landing-feature-910-23uvld.herokuapp.com/ |
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
LGTM 😎 only some small issues with code block formatting. I left a few comments.
jorgeorpinel
left a comment
jorgeorpinel
left a comment
There was a problem hiding this comment.
Looks good. I just wonder if we need dvc.api to link to the API ref. Probably yes but maybe also remove some manual links that make it repetitive, like this one from https://dvc-landing-feature-910-23uvld.herokuapp.com/doc/install
There was a problem hiding this comment.
I'm not particularly knowledgeable about the internal DVC linker plugin, but the code itself looks good to me.
@mvshmakov I have to ask: is your editor automatically changing the indentation of the MD code blocks @shcheklein pointed out or is it a deliberate choice? I don't have strong feelings either way, but it doesn't seem to be our linter.
It's probably best to revert just the indentation-only changes to how they were originally, and if there's a legitimate reason to change them we can address that as its own issue. Either way, nice contribution! Thanks!
I have removed what you suggested, and I can't find anything like this anymore. |
| Our Python API, included with the `dvc` package installed with DVC, includes the | ||
| `open` function to load/stream data directly from external <abbr>DVC | ||
| projects</abbr>: | ||
| Our Python API (`dvc.api`), included with the `dvc` package installed with DVC, |
There was a problem hiding this comment.
Here I would actually prefer to link [Python API] manually for readability.
There was a problem hiding this comment.
Done in 036672d along with a couple more instances I found.
jorgeorpinel
left a comment
jorgeorpinel
left a comment
There was a problem hiding this comment.
Thanks, LGTM! Just left an optional suggestion ☝️
|
@jorgeorpinel I will merge this (since you approved and to move forward), let's update that text as part of the regular PRs? |
|
Sure! |
4 participants
Fix #910