Improve function comment layout for pdoc - Githubissues

apache / incubator-teaclave

Apache Teaclave (incubating) is an open source universal secure computing platform, making computation on privacy-sensitive data safe and simple.

https://teaclave.apache.org

Apache License 2.0

765 stars 158 forks source link

Improve function comment layout for pdoc #670

Closed GeminiCarrie closed 1 year ago

GeminiCarrie commented 1 year ago

Putting the arguments in different lines improves readability.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes # (issue)

Type of change (select or add applied and delete the others)

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] API change with a documentation update
[ ] Additional test coverage
[ ] Code cleanup or just sync with upstream third-party crates

How has this been tested?

Checklist

[ ] Fork the repo and create your branch from master.
[ ] If you've added code that should be tested, add tests.
[ ] If you've changed APIs, update the documentation.
[ ] Ensure the tests pass (see CI results).
[ ] Make sure your code lints/format.