tentacat icon indicating copy to clipboard operation
tentacat copied to clipboard

Documentation doesn't mention you can pass parameters

Open 2016rshah opened this issue 8 years ago • 3 comments

As you can see here the documentation doesn't mention you can pass in parameters like [sort: "pushed"] to the function even though that feature has already been implemented.

2016rshah avatar Apr 09 '16 22:04 2016rshah

Thanks for the heads up. Feel free to send a PR adding this info :+1:

edgurgel avatar Apr 10 '16 10:04 edgurgel

There are multiple functions that pass parameters even if it isn't mentioned in the Tentacat docs (possible parameters are enumerated on the Github docs). Would it be better to add a blanket statement somewhere that mentions that if the Github documentation says you can pass parameters, then you can do so with Tentacat? That might be a bit more DRY than mentioning it in the documentation for every endpoint, right?

2016rshah avatar Apr 10 '16 18:04 2016rshah

Agreed. We should probably set up an initial page for the docs and put a Getting Started explaining these things here: https://hexdocs.pm/tentacat

edgurgel avatar Apr 10 '16 21:04 edgurgel