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

Documentation doesn't mention you can pass parameters #72

Open
2016rshah opened this issue Apr 9, 2016 · 3 comments
Open

Documentation doesn't mention you can pass parameters #72

2016rshah opened this issue Apr 9, 2016 · 3 comments

Comments

@2016rshah
Copy link

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.

@edgurgel
Copy link
Owner

Thanks for the heads up. Feel free to send a PR adding this info 👍

@2016rshah
Copy link
Author

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?

@edgurgel
Copy link
Owner

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

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

No branches or pull requests

2 participants