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

docs: Fix typedoc warnings for API ref #295

Merged
merged 1 commit into from
Oct 31, 2024
Merged

docs: Fix typedoc warnings for API ref #295

merged 1 commit into from
Oct 31, 2024

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Oct 31, 2024

Description

  • Fixes several JSDoc links so Typedoc renders them correctly.
  • Adds several types and classes to the entrypoint so Typedoc can produce docs for them.

Motivation and context

DOCS-3676

Currently, running npm run doc produces several warnings. This fixes those.

This also ensures API reference docs for the driver are complete.

Note: The overview.md readme file still admits one warning, but it's a false positive. We can safely ignore it for now. I'll see if I can silence it later.

How was the change tested?

Run npm run doc locally with the changes.

Screenshots (if appropriate):

Change types

    • Bug fix (non-breaking change that fixes an issue)
    • New feature (non-breaking change that adds functionality)
    • Breaking change (backwards-incompatible fix or feature)

Checklist:

    • My code follows the code style of this project.
    • My change requires a change to Fauna documentation.
    • My change requires a change to the README, and I have updated it accordingly.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jrodewig jrodewig merged commit 5e7313b into main Oct 31, 2024
7 checks passed
@jrodewig jrodewig deleted the fix-api-ref branch October 31, 2024 14:45
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

Successfully merging this pull request may close these issues.

2 participants