Skip to content

Unify doc strings#13

Merged
Eleven1Liu merged 2 commits intontumlgroup:masterfrom
Eleven1Liu:unify_comments
May 21, 2025
Merged

Unify doc strings#13
Eleven1Liu merged 2 commits intontumlgroup:masterfrom
Eleven1Liu:unify_comments

Conversation

@Eleven1Liu
Copy link
Copy Markdown
Contributor

@Eleven1Liu Eleven1Liu commented May 21, 2025

What does this PR do?

Unify doc strings in the following formats:

  • Remove "s" from the first verb of each sentence when ignoring the subject.
  • Uppercase the first word and add a period at the end.

Test CLI & API (bash tests/autotest.sh)

Test APIs used by main.py.

  • Test Pass
    • (Copy and paste the last outputted line here.)
  • Not Applicable (i.e., the PR does not include API changes.)

Check API Document

If any new APIs are added, please check if the description of the APIs is added to API document.

  • API document is updated (linear, nn)
  • Not Applicable (i.e., the PR does not include API changes.)

Test quickstart & API (bash tests/docs/test_changed_document.sh)

If any APIs in quickstarts or tutorials are modified, please run this test to check if the current examples can run correctly after the modified APIs are released.

@Eleven1Liu Eleven1Liu requested a review from chcwww May 21, 2025 10:18
@Eleven1Liu Eleven1Liu added enhancement New feature or request code format and removed enhancement New feature or request labels May 21, 2025
@Eleven1Liu Eleven1Liu marked this pull request as ready for review May 21, 2025 14:03
@Eleven1Liu Eleven1Liu requested review from a team and cjlin1 as code owners May 21, 2025 14:03
@Eleven1Liu Eleven1Liu merged commit 5972bee into ntumlgroup:master May 21, 2025
1 check passed
@Eleven1Liu Eleven1Liu deleted the unify_comments branch May 21, 2025 23:11
@Eleven1Liu Eleven1Liu added the documentation Improvements or additions to documentation label May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code format documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants