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

Fix jsdocs #545

Merged
merged 1 commit into from
Feb 4, 2021
Merged

Fix jsdocs #545

merged 1 commit into from
Feb 4, 2021

Conversation

Falci
Copy link
Member

@Falci Falci commented Jan 28, 2021

JSDoc is complaining about a few optional parameters.
Optional parameters should be placed between [square bracket] instead of prefixed with ?

@coveralls
Copy link

coveralls commented Jan 28, 2021

Pull Request Test Coverage Report for Build 518043994

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage remained the same at 59.606%

Files with Coverage Reduction New Missed Lines %
lib/covenants/rules.js 1 67.45%
Totals Coverage Status
Change from base Build 512602537: 0.0%
Covered Lines: 19512
Relevant Lines: 30510

💛 - Coveralls

@pinheadmz
Copy link
Member

Looks like there's a ton more of these:

$ grep lib/*/*.js lib/*.js -e '?}' | wc -l
     326

Do we need to replace them all? Any reason why you only fixed in path.js ?

@Falci
Copy link
Member Author

Falci commented Feb 4, 2021

For some reason, it only fails for the custom types (Network)

Copy link
Member

@pinheadmz pinheadmz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok cool thanks. Confirmed that jsdocs threw an error on master branch and this fixes that error. I think we have tons more work to do on jsdocs, but at least this is a good starting point.

ACK d45d5a7

Show Signature
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

ACK d45d5a75932b863389c688074ffc622e9ea8e619
-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEE5hdzzW4BBA4vG9eM5+KYS2KJyToFAmAcNJgACgkQ5+KYS2KJ
yTo3uw//RFKC2cMj6rH/Il168PDku8rTifu+3criIHmoQUopLG10xALf7oZBLWYR
arX3r7matE/2vazxFJ9kstJsKQvJNh34zLLX93Sj2I4bQQlHE7YsbMiQZNTddBYT
qeDw/aF12fKHRtryoNrl8/Pqj1h6hLKjpLPtTRQKYaDvVB2uM2e8UIIEqRyjQsCR
L6P6bF5B0EciTn8ygBW5q/a60qrzqaJiTqTQM70Dd5Sm4LCytn7qiK7LdAIvIj0+
AmeGiuYSQUS2DWKcef/a7TSlZjwy9lUQvfDtka7IlNmvywWusCqnGh0kRDegewhJ
Qu8+5YJT78aqKa+0HWhxHwtLDofxhOZLQbJqRIiQITnsTueWvM5P0BnvDfLohv9B
CikF5m5Hti4Qqb30iR/nAdPq4aLAoqy+/YT3l3JLwv6PJ/syj8LFP06etGn7W4PB
Qhws9kQszjmLFEfHckW+eFxf24nL9cR1YEVQvw5FCJ71fDAHNgfsKnXfGMkgaNLs
BqoobFNQu4gkDIcC5MuI3NZ9/B0D5M09RCtjOrYlI8SoUq+u1n/cNhDJu54zxUAW
NtJLQsC4DoFO0vPvM4C0V9EdPCuyMIUN2C30rBzPM/R0ivqS9GTEeH8wZ7HWzZyv
Z09+n0UPnvulicN83/ofo19ODPia273i1OHVyij8XkqE/qyNxSY=
=U9ST
-----END PGP SIGNATURE-----

pinheadmz's public key is on keybase

@pinheadmz pinheadmz merged commit e270b8c into handshake-org:master Feb 4, 2021
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

3 participants