tealdeer-rs / tealdeer

A very fast implementation of tldr in Rust.
https://tealdeer-rs.github.io/tealdeer/
Apache License 2.0
4.17k stars 123 forks source link

Update test reference for 'tar' tldr page #186

Closed SimplyDanny closed 3 years ago

dbrgn commented 3 years ago

Thanks! We should really switch away from tar (which is being updated quite often) to a rarely updated command.

SimplyDanny commented 3 years ago

What about pages/common/pygmentize.md? It was last touched in 2017 and it is not overly simple and short.

dbrgn commented 3 years ago

@SimplyDanny a PR that updates the test files would be welcome! We could also use the page for which. It's not simpler than pygmentize, but shorter.

SimplyDanny commented 3 years ago

pages/common/which.md is pretty simple with respect to {{variables}}. I thought something more complex is preferred. We can also argue, though, that the integration test shall not test complex logic but just how everything works together. So if you like which more and think it is sufficient, I'm happy to open a PR to switch to it.

dbrgn commented 3 years ago

Well, as long as it contains examples and variables, I think that's sufficient. Or do you see any complexity in pygmentize that's not in which?

SimplyDanny commented 3 years ago

pygmentize has example code with multiple variables in one line with variable names not being just single words, like file names. But yeah, as said above, an integration test may use a simple example if the details are tested in other (unit) tests. So let's take which. 😉

niklasmohrin commented 3 years ago

We could also use the one for tldr, this way are guaranteed to notice any changes to the spec 😂