Skip to content

IGNITE-21051 Bulletpoints added for index discovering algorithms in Javadoc in IndexQuery class#11091

Merged
timoninmaxim merged 5 commits intoapache:masterfrom
oleg-vlsk:ignite-21051
Dec 18, 2023
Merged

IGNITE-21051 Bulletpoints added for index discovering algorithms in Javadoc in IndexQuery class#11091
timoninmaxim merged 5 commits intoapache:masterfrom
oleg-vlsk:ignite-21051

Conversation

@oleg-vlsk
Copy link
Copy Markdown
Contributor

@oleg-vlsk oleg-vlsk commented Dec 13, 2023

Thank you for submitting the pull request to the Apache Ignite.

In order to streamline the review of the contribution
we ask you to ensure the following steps have been taken:

The Contribution Checklist

  • There is a single JIRA ticket related to the pull request.
  • The web-link to the pull request is attached to the JIRA ticket.
  • The JIRA ticket has the Patch Available state.
  • The pull request body describes changes that have been made.
    The description explains WHAT and WHY was made instead of HOW.
  • The pull request title is treated as the final commit message.
    The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
  • A reviewer has been mentioned through the JIRA comments
    (see the Maintainers list)
  • The pull request has been checked by the Teamcity Bot and
    the green visa attached to the JIRA ticket (see TC.Bot: Check PR)

Notes

If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com #ignite channel.

timoninmaxim
timoninmaxim reviewed Dec 13, 2023
View reviewed changes
modules/core/src/main/java/org/apache/ignite/cache/query/IndexQuery.java Outdated
@@ -33,9 +33,11 @@
* {@code QueryCursor} delivers sorted cache entries by the order defined for queried index.
*
Copy link
Copy Markdown
Member

@timoninmaxim timoninmaxim Dec 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Hi! Thanks for the patch. It looks good. One more thing here. Let's add the <p> tag here for correct rendering this paragraphs also. Thanks!

Copy link
Copy Markdown
Contributor Author

@oleg-vlsk oleg-vlsk Dec 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Hello! The <p> tag has been added before “{@code QueryCursor} delivers...”. Is that correct or did you mean that each sentence needs to be a separate paragraph (“{@code QueryCursor} delivers...”, “{@code IndexQuery} has to be...”, and then “The algorithm of discovering index...”)?

Copy link
Copy Markdown
Member

@timoninmaxim timoninmaxim Dec 14, 2023

Choose a reason for hiding this comment

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

@oleg-vlsk Hi! I mean to separate paragraphs the same way how it does in javadoc. You can check how it actually renders with the button "Toggle Rendered View" in Intellij IDEA.

Снимок экрана 2023-12-14 в 10 45 18

timoninmaxim
timoninmaxim reviewed Dec 15, 2023
View reviewed changes
modules/core/src/main/java/org/apache/ignite/cache/query/IndexQuery.java Outdated
* 1. If {@link #idxName} is set, then use it.
* 2. If {@link #idxName} is not set, then find an index that matches criteria fields.
* 3. If neither {@link #idxName}, nor {@link #setCriteria(List)} is used, then perform index scan over PK index for specified Value type.
* <p>{@code IndexQuery} has to be initialized with cache value class or type. The algorithm of discovering index is
Copy link
Copy Markdown
Member

@timoninmaxim timoninmaxim Dec 15, 2023

Choose a reason for hiding this comment

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

Here and above, please check how this tag is used in other classes. For example, you can check classes ContinuousQueryWithTransformer or QueryCursor.

I mean this tag usually occupies whole line, no symbols are present on the same line.

Copy link
Copy Markdown
Contributor Author

@oleg-vlsk oleg-vlsk Dec 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@timoninmaxim The changes have been made, each <p> tag occupies a whole line now.

@timoninmaxim timoninmaxim merged commit 136e9a3 into apache:master Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timoninmaxim timoninmaxim timoninmaxim approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@oleg-vlsk @timoninmaxim