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

Use square brackets to denote optional parameters #5806

Closed
ramya-rao-a opened this issue Oct 25, 2019 · 3 comments
Closed

Use square brackets to denote optional parameters #5806

ramya-rao-a opened this issue Oct 25, 2019 · 3 comments
Labels
EngSys This issue is impacting the engineering system. Storage Storage Service (Queues, Blobs, Files)

Comments

@ramya-rao-a
Copy link
Contributor

JSDoc suggests certain formats when it comes to optional parameters and parameters with default values. See https://jsdoc.app/tags-param.html#optional-parameters-and-default-values

Storage libraries followed this guideline until #5791 where it got removed.

This issue is to discuss if we should indeed follow the above format and if yes, then to add it to not just storage, but all other libraries

@ramya-rao-a ramya-rao-a added Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files) labels Oct 25, 2019
@XiaoningLiu
Copy link
Member

Hi Ramya, I think JSDoc takes this as a rule/standard instead of a suggestion. We need to follow them if Azure JS SDK decides to follow JSDoc.

@ljian3377
Copy link
Member

What's the status of storage packages now regarding the guideline?
Can we add some pipeline rule to enforce it?

@ljian3377 ljian3377 added EngSys This issue is impacting the engineering system. and removed Client This issue points to a problem in the data-plane of the library. labels Oct 21, 2020
@ramya-rao-a
Copy link
Contributor Author

I'll close this in favor of #3027.
In the coming months we will look into linter checks that we can add which will help here

@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
EngSys This issue is impacting the engineering system. Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

No branches or pull requests

4 participants