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.

Sign up for GitHub

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

Jump to bottom

SNOW-1016469: Adding missing comments to public methods #1928

Merged
merged 32 commits into from
Nov 6, 2024
Merged

SNOW-1016469: Adding missing comments to public methods #1928

merged 32 commits into from
Nov 6, 2024

Conversation

sfc-gh-ext-simba-jf
Copy link
Collaborator

@sfc-gh-ext-simba-jf sfc-gh-ext-simba-jf commented Oct 17, 2024 •
edited by sfc-gh-dprzybysz
Loading

Overview

SNOW-1016469

Pre-review self checklist

  • PR branch is updated with all the changes from master branch
  • The code is correctly formatted (run mvn -P check-style validate)
  • New public API is not unnecessary exposed (run mvn verify and inspect target/japicmp/japicmp.html)
  • The pull request name is prefixed with SNOW-XXXX:
  • Code is in compliance with internal logging requirements

External contributors - please answer these questions before submitting a pull request. Thanks!

  1. What GitHub issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

    Issue: #NNNN

  2. Fill out the following pre-review checklist:

    • I am adding a new automated test(s) to verify correctness of my new code
    • I am adding new logging messages
    • I am modifying authorization mechanisms
    • I am adding new credentials
    • I am modifying OCSP code
    • I am adding a new dependency or upgrading an existing one
    • I am adding new public/protected component not marked with @SnowflakeJdbcInternalApi (note that public/protected methods/fields in classes marked with this annotation are already internal)

  3. Please describe how your code solves the related issue.

    Please write a short description of how your code change solves the related issue.

sfc-gh-ext-simba-jf and others added 19 commits October 17, 2024 15:36
@sfc-gh-ext-simba-jf
Adding missing comments to public methods part 1
a936500
@sfc-gh-ext-simba-jf
Add missing comments part 2
bdf5c36
@sfc-gh-ext-simba-jf
Merge branch 'master' into SNOW-1016469-Update-Javadocs-With-missing-…
221e202 
…comments
@sfc-gh-ext-simba-jf
Merge branch 'master' into SNOW-1016469-Update-Javadocs-With-missing-…
6efb936 
…comments
@sfc-gh-ext-simba-jf
Adding missing javadocs part 3
a261619
@sfc-gh-ext-simba-jf
Add missing javadocs part 4
b5800ba
@sfc-gh-ext-simba-jf
java doc update part 5
a91a006
@sfc-gh-ext-simba-jf
java doc update part 6
3e0678b
@sfc-gh-ext-simba-jf
Merge branch 'master' into SNOW-1016469-Update-Javadocs-With-missing-…
34c6737 
…comments
@sfc-gh-ext-simba-jf
Added more javadocs part 7
47632ba
@sfc-gh-ext-simba-jf
java doc update part 8
9123e30
@sfc-gh-ext-simba-jf
java doc updates part 9
d1876df
@sfc-gh-ext-simba-jf
Merge branch 'SNOW-1016469-Update-Javadocs-With-missing-comments' of h…
d6b6ee8 
…ttps://github.com/snowflakedb/snowflake-jdbc into SNOW-1016469-Update-Javadocs-With-missing-comments
@sfc-gh-ext-simba-jf
Merge branch 'master' into SNOW-1016469-Update-Javadocs-With-missing-…
ce70f98 
…comments
@sfc-gh-ext-simba-jf
Fix missing javadocs part 10
cd11018
@sfc-gh-ext-simba-jf
Merge branch 'SNOW-1016469-Update-Javadocs-With-missing-comments' of h…
72bd1d1 
…ttps://github.com/snowflakedb/snowflake-jdbc into SNOW-1016469-Update-Javadocs-With-missing-comments
@sfc-gh-ext-simba-jf
fix missing javadoc comments part 11
11135b9
@sfc-gh-ext-simba-jf
javadoc update part 12
4f61f1b
@sfc-gh-ext-simba-jf
Merge branch 'master' into SNOW-1016469-Update-Javadocs-With-missing-…
f90829f 
…comments
@sfc-gh-ext-simba-jf sfc-gh-ext-simba-jf marked this pull request as ready for review October 25, 2024 17:57
@sfc-gh-ext-simba-jf sfc-gh-ext-simba-jf requested a review from a team as a code owner October 25, 2024 17:57
@sfc-gh-dprzybysz sfc-gh-dprzybysz changed the title Adding missing comments to public methods SNOW-1016469: Adding missing comments to public methods Oct 29, 2024
sfc-gh-dprzybysz
sfc-gh-dprzybysz reviewed Oct 30, 2024
View reviewed changes
src/main/java/net/snowflake/client/core/DataConversionContext.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/core/HttpUtil.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/core/PrivateLinkDetector.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/core/ResultUtil.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/core/ResultUtil.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/core/arrow/BitToBooleanConverter.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/jdbc/ArrowResultChunk.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/jdbc/SFConnectionHandler.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/jdbc/SnowflakeColumn.java Outdated Show resolved Hide resolved
src/main/java/net/snowflake/client/jdbc/SnowflakeSQLLoggedException.java Outdated Show resolved Hide resolved
@sfc-gh-dprzybysz sfc-gh-dprzybysz merged commit 3aac6be into master Nov 6, 2024
140 of 142 checks passed
@sfc-gh-dprzybysz sfc-gh-dprzybysz deleted the SNOW-1016469-Update-Javadocs-With-missing-comments branch November 6, 2024 09:17
@github-actions github-actions bot locked and limited conversation to collaborators Nov 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sfc-gh-dprzybysz sfc-gh-dprzybysz sfc-gh-dprzybysz approved these changes

@sfc-gh-mkubik sfc-gh-mkubik sfc-gh-mkubik 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.
3 participants
@sfc-gh-ext-simba-jf @sfc-gh-dprzybysz @sfc-gh-mkubik