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

describe-package: fix examples #837

Merged
merged 2 commits into from
Dec 4, 2024
Merged

describe-package: fix examples #837

merged 2 commits into from
Dec 4, 2024

Conversation

josephjclark
Copy link
Collaborator

Short Description

If an example includes a {@link } tag (and it shouldn't!), it'll trigger an error and docs won't show up in Lightning.

This fix makes the example parser more stable - but note that any offending examples will not be displayed in lightning's adaptor docs.

Fixes OpenFn/adaptors#854

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our Responsible AI Policy

@josephjclark josephjclark merged commit c2aedec into main Dec 4, 2024
7 checks passed
@josephjclark josephjclark deleted the fix-examples branch December 4, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

dhis2: docs are broken on app.openfn.org
1 participant