Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs do a poor job of explain what this library does #141

Closed
SUPERCILEX opened this issue Oct 1, 2022 · 4 comments
Closed

Docs do a poor job of explain what this library does #141

SUPERCILEX opened this issue Oct 1, 2022 · 4 comments

Comments

@SUPERCILEX
Copy link
Contributor

SUPERCILEX commented Oct 1, 2022

It took me several hours to understand how this library worked... the docs need a lot of love.

  • In the readme and intro docs, a test is added with that looks through "tests/cmd/*.trycmd" but no example is shown of a trycmd so I had no idea these files actually needed to exist (I thought TRYCMD=dump would create them and was very confused for a while). An example of the trycmd file is needed.
  • It also needs to be mentioned that md files are interpreted the same way.
  • The example here makes no sense. It looks like that rust code will be compiled on the fly (it isn't) and where is my-cmd coming from? And how does the output make any sense? It says print hello world but then only hello is printed. This example needs to be completely reworked: it should clearly and explicitly be shown that you have a basic rust binary with a main function that prints something, an md/trycmd file that calls that binary (no need for input params), and a test that has the trycmd file as a case.
  • Eliding content needs an example because I still can't figure out what it does: [EXE] not being removed #140
@epage
Copy link
Contributor

epage commented Oct 4, 2022

See

@epage epage closed this as completed Oct 4, 2022
@SUPERCILEX
Copy link
Contributor Author

This is very disappointing: it misses the point that there should be a concrete example. You've described the example without actually providing a real example people can look at. Also it's deeply ironic to have incorrect examples because you aren't using the library you're trying to demo.

@epage
Copy link
Contributor

epage commented Oct 4, 2022

This is very disappointing: it misses the point that there should be a concrete example.

This issue is not about a concrete example but specific pain points. Feel free to create an issue about concrete examples

Roll up issues are not ideal because they are rarely ever "done", being a constant moving target.

@SUPERCILEX
Copy link
Contributor Author

Feel free to create an issue about concrete examples

Sure: #146

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants