tentacat
tentacat copied to clipboard
Documentation doesn't mention you can pass parameters
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.
Thanks for the heads up. Feel free to send a PR adding this info :+1:
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?
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