Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

docs: help for dev find-implementations-diff #180

Open
aguschin opened this issue Sep 19, 2022 · 6 comments
Open

docs: help for dev find-implementations-diff #180

aguschin opened this issue Sep 19, 2022 · 6 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/{command,api,object}-reference p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.

Comments

@aguschin
Copy link
Contributor

$ mlem dev find-implementations-diff

this is a command for devs - who wants to add an extension or fix something in MLEM. Currently I've added link to https://mlem.ai/doc/contributing/core which is shown if you call --help, but that page in fact doesn't have anything about it. It would be useful if we add some guide for devs on using this command in https://mlem.ai/doc/contributing/core or in command-reference.

@aguschin aguschin added the C: ref Content of /doc/{command,api,object}-reference label Sep 19, 2022
@shcheklein shcheklein added the A: docs Area: user documentation (gatsby-theme-iterative) label Sep 19, 2022
@jorgeorpinel
Copy link
Contributor

Hi. I see this is not in https://mlem.ai/doc/command-reference but also not being added by https://github.com/iterative/mlem.ai/pull/172/files . Is it a hidden feature?

@aguschin
Copy link
Contributor Author

@jorgeorpinel, yes, it is hidden CLI command. You won't see it in mlem --help.

@jorgeorpinel jorgeorpinel added the p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. label Sep 22, 2022
@jorgeorpinel
Copy link
Contributor

Then just mentioning in https://mlem.ai/doc/contributing should be enough then. Or what usage info specifically do you think would be useful?

@jorgeorpinel
Copy link
Contributor

p.s. please reprioritize if needed. In my experience it's just good to have a sense of priorities in most tickets for later planning and grooming.

@aguschin
Copy link
Contributor Author

Then just mentioning in https://mlem.ai/doc/contributing should be enough then. Or what usage info specifically do you think would be useful?

Agreed, it should be enough.

@mike0sv
Copy link
Contributor

mike0sv commented Oct 3, 2022

It's old and hidden, I suggest we don't do a page for it. In iterative/mlem#408 you can skip check for hidden commands

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/{command,api,object}-reference p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.
Projects
None yet
Development

No branches or pull requests

4 participants