Skip to content

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

Open
@ptpaterson

Description

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.

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions