Skip to content
New issue

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

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

Already on GitHub? # to your account

Javadocs for query functions point to old/missing documentation #307

Open
ptpaterson opened this issue May 6, 2021 · 0 comments
Open

Javadocs for query functions point to old/missing documentation #307

ptpaterson opened this issue May 6, 2021 · 0 comments

Comments

@ptpaterson
Copy link

I'm getting started with the scala driver. I noticed that the links point to the old documentation pages. For example:

/**
* A Paginate expression.
*
* '''Reference''': [[https://app.fauna.com/documentation/reference/queryapi#read-functions]]
*/
def Paginate(

should probably point to https://docs.fauna.com/fauna/current/api/fql/functions/paginate?lang=scala

I'm familiar with the docs (got the cheat sheet on my toolbar, too), so I am good there. But the links were confusing me for a bit :). If some folks new to fauna are coming in with Scala in mind, that might throw them off more. 🤷🏻‍♂️

It looks like each query function could point directly to it's respective docs page. That is something that I could help with. Just a tedious chore and no touching of business logic -- right up my alley for a Scala repo 🙂 and assuming I understand what the intent is correctly.

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

No branches or pull requests

1 participant