Skip to content

Improve function comment layout for pdoc#670

Merged
mssun merged 1 commit intoapache:masterfrom
GeminiCarrie:master
Jan 13, 2023
Merged

Improve function comment layout for pdoc#670
mssun merged 1 commit intoapache:masterfrom
GeminiCarrie:master

Conversation

@GeminiCarrie
Copy link
Contributor

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.

Putting the arguments in different lines improves readability.
@mssun mssun self-requested a review January 13, 2023 04:30
Copy link
Member

@mssun mssun left a comment

Choose a reason for hiding this comment

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

LGTM.

@mssun mssun merged commit a8dad2b into apache:master Jan 13, 2023
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