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

Many Javadoc comments contain text #4731

Closed
wissenstein opened this issue Jun 11, 2023 · 4 comments
Closed

Many Javadoc comments contain text #4731

wissenstein opened this issue Jun 11, 2023 · 4 comments
Assignees
Labels
Milestone

Comments

@wissenstein
Copy link

wissenstein commented Jun 11, 2023

Version

4.4.2

Context

I can see that many Javadoc comments about deprecated TimeoutStream functionality contain text: 'Rx java like integrations should use the Vert.s scheduler integration'. I think, Vert.s should be replaced with Vert.x there.

Do you have a reproducer?

It can be found in Javadocs at least at following links:

https://vertx.io/docs/apidocs/io/vertx/core/TimeoutStream.html

https://vertx.io/docs/apidocs/io/vertx/core/Vertx.html#periodicStream-long-

https://vertx.io/docs/apidocs/io/vertx/core/Vertx.html#periodicStream-long-long-

https://vertx.io/docs/apidocs/io/vertx/core/Vertx.html#timerStream-long-

Steps to reproduce

Open any of the mentioned links and find a section 'Deprecated'

Actual result

The text mentions 'Vert.s'.

Expected result

The text mentions 'Vert.x' instead.

@vietj
Copy link
Member

vietj commented Jun 11, 2023

such classes were designed to produce Observable for RX and. are removed in vertx 5, hence the comment which indicates what to use instead.

@tsegismont tsegismont added this to the 4.4.4 milestone Jun 12, 2023
@tsegismont tsegismont self-assigned this Jun 12, 2023
@tsegismont
Copy link
Contributor

Right @vietj . I think @wissenstein reported this only because of the typo (Vert.s instead of Vert.x).

@vietj
Copy link
Member

vietj commented Jun 12, 2023

oh right, feel free to provide a PR to fix that :-)

tsegismont added a commit that referenced this issue Jun 12, 2023
Fixes #4731

Signed-off-by: Thomas Segismont <tsegismont@gmail.com>
@tsegismont
Copy link
Contributor

Fixed by f496856

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants