Skip to content

Remove ToDo showing up in public facing API reference #6015

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

ambikab
Copy link

@ambikab ambikab commented Apr 8, 2025

Motivation and Context

Solves: #5523

Modifications

Removed a ToDo from a public facing documentation.

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • [x I have read the CONTRIBUTING document
  • [x ] Local run of mvn install succeeds
  • [x ] My code follows the code style of this project
  • [x ] My change requires a change to the Javadoc documentation
  • [x ] I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@ambikab ambikab requested a review from a team as a code owner April 8, 2025 06:46
@debora-ito
Copy link
Member

Hi @ambikab thank you for the PR.

We shouldn't remove the TODO though, just hide it from the public Javadoc comment. You can replace /** with /* to achieve this.

@ambikab
Copy link
Author

ambikab commented Apr 9, 2025

Hi @ambikab thank you for the PR.

We shouldn't remove the TODO though, just hide it from the public Javadoc comment. You can replace /** with /* to achieve this.
Thanks for the pointers. Addressed.

Copy link
Member

@debora-ito debora-ito left a comment

Choose a reason for hiding this comment

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

Thank you! I'll start the builds.

@debora-ito debora-ito enabled auto-merge April 14, 2025 21:03
@debora-ito debora-ito added this pull request to the merge queue Apr 14, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 14, 2025
@debora-ito debora-ito added this pull request to the merge queue Apr 14, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 14, 2025
@debora-ito debora-ito added this pull request to the merge queue Apr 15, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 15, 2025
@debora-ito debora-ito added this pull request to the merge queue Apr 15, 2025
github-merge-queue bot pushed a commit that referenced this pull request Apr 15, 2025
* Remove ToDo showing up in public facing API reference

* Hide ToDos appearing on public javadoc

---------

Co-authored-by: Ambika Babuji <[email protected]>
Co-authored-by: Debora N. Ito <[email protected]>
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 15, 2025
@debora-ito
Copy link
Member

There may be some checkstyle checks failing, taking a look.

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