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: Issue 76 Replacing undocumented comments with actual comments using JSDoc #82

Closed
wants to merge 2 commits into from
Closed

docs: Issue 76 Replacing undocumented comments with actual comments using JSDoc #82

wants to merge 2 commits into from

Conversation

abhishekgite446
Copy link

@abhishekgite446 abhishekgite446 commented Jun 21, 2023

  • Replacing undocumented comments with actual comments using JSDoc

@abhishekgite446 abhishekgite446 requested a review from a team as a code owner June 21, 2023 20:03
@abhishekgite446 abhishekgite446 changed the title Issue 76 - Replacing undocumented comments with actual comments using JSDoc docs: Issue 76 Replacing undocumented comments with actual comments using JSDoc Jun 21, 2023
@abhishekgite446
Copy link
Author

@dsanders11 I have tried replacing the undocumented comments as suggested in Issue 76. Can you please confirm if you were expecting the same ? If yes then I would replace the other undocumented comments.

BTW this is my first contribution to any OpenSource so please bare with my stupid queries.

@abhishekgite446 abhishekgite446 deleted the Issue-76-API-Documentation branch June 21, 2023 21:06
@abhishekgite446
Copy link
Author

Closing the PR due to an issue in my git.

@dsanders11
Copy link
Member

@abhishekgite446, these changes looked good, if you want to continue them after you resolve your git issues. 🙂

@dsanders11
Copy link
Member

Actually, sorry, took a closer look (d'oh). These descriptions should include changes to the src/ files, and then yarn docs will update etc/fiddle-core.api.md.

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.

3 participants