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

Improve documentation for synonym functions #800

Merged
merged 12 commits into from
Nov 24, 2023

Conversation

ilesinge
Copy link
Contributor

@ilesinge ilesinge commented Nov 11, 2023

  • Adds a JSDoc plugin to better parse @synonym tags
  • Show tooltips for synonym function names
  • Show synonyms in API reference
  • Simplify JSDoc React component

Question: should we move all JSDoc-related files from the root folder to a 'jsdoc' subfolder?

@ilesinge ilesinge marked this pull request as ready for review November 11, 2023 14:55
@felixroos
Copy link
Collaborator

nice, didn't know you can write jsdoc plugins to do stuff like this.

Question: should we move all JSDoc-related files from the root folder to a 'jsdoc' subfolder?

sounds reasonable

@ilesinge
Copy link
Contributor Author

In my latest commits I moved jsdoc-related files to a jsdoc subfolder, except doc.json and undocumented.json.
I also changed the undocumented.json file so that path do not include the local path to the main project folder, only from the project root, so it can be updated by anyone.
I think the PR is ready :)

@felixroos
Copy link
Collaborator

thanks! I've added some small additions:

  • also show the synonyms in the Autocomplete component
  • there was a little bug where synonyms wouldn't work anymore on hover because entry.name was mutated.
  • all synonyms now work in the autocomplete feature as well

@felixroos felixroos merged commit 5e7e1ff into tidalcycles:main Nov 24, 2023
@ilesinge
Copy link
Contributor Author

Great, thank you 🙌

@ilesinge ilesinge deleted the improve_doc branch November 24, 2023 11:00
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.

None yet

2 participants