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

chore: disable autofixing jsdoc lint warnings #1

Open
wants to merge 1 commit into
base: adam/feat/restored-aztec2-api
Choose a base branch
from

Conversation

TomAFrench
Copy link

Description

We don't have jsdoc set up on the vast majority of functions so vscode tends to wreck havoc adding empty multiline comments everywhere in the ts directory. I've then disabled this in the vscode settings file to allow us to add documentation progressively.

Checklist:

  • I have reviewed my diff in github, line by line.
  • Every change is related to the PR description.
  • I have linked this pull request to the issue(s) that it resolves.
  • There are no unexpected formatting changes, superfluous debug logs, or commented-out code.
  • There are no circuit changes, OR specifications in /markdown/specs have been updated.
  • There are no circuit changes, OR a cryptographer has been assigned for review.
  • I've updated any terraform that needs updating (e.g. environment variables) for deployment.
  • The branch has been rebased against the head of its merge target.
  • I'm happy for the PR to be merged at the reviewer's next convenience.
  • New functions, classes, etc. have been documented according to the doxygen comment format. Classes and structs must have @brief describing the intended functionality.
  • If existing code has been modified, such documentation has been added or updated.

@TomAFrench TomAFrench changed the title feat: disable autofixing jsdoc lint warnings chore: disable autofixing jsdoc lint warnings Mar 16, 2023
@ludamad
Copy link
Owner

ludamad commented May 29, 2023

@TomAFrench I forget, was there a reason this was in my personal repo?

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