Skip to content

Conversation

@chrischild
Copy link
Contributor

@chrischild chrischild commented Oct 25, 2019

I'm sorry I had to delete the last branch. I found out I had been committing some info I didn't want to be and then when I went to re-open the issue I wasn't allowed to.

Old PR is here

Fixes #5530

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

<!-- 4. longerVariableOrMethodName -->
<!--module name="com.azure.tools.checkstyle.checks.BlacklistedWordsCheck">
<property name="blacklistedWords" value="URL, HTTP, XML, JSON, SAS, CPK, API" />
</module-->
Copy link
Contributor Author

@chrischild chrischild Oct 25, 2019

Choose a reason for hiding this comment

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

Will uncomment this once the naming issues have been fixed. Otherwise it'll break the build.

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense. :)

Copy link
Member

@conniey conniey left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

/**
* Should we check member with given modifiers.
*
* @param token
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: is it format better if keeping

@param token modifiers of the member to check.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good. I also saw the other note about the same issue on another method.

Copy link
Contributor

@mssfang mssfang left a comment

Choose a reason for hiding this comment

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

Just a minor nit on formatting. LGTM as well!.

@chrischild
Copy link
Contributor Author

@JonathanGiles said only Public API's should be checked. What is considered public? Anything under sdk? Should the sample code also be checked?

@conniey
Copy link
Member

conniey commented Oct 26, 2019

@JonathanGiles said only Public API's should be checked. What is considered public? Anything under sdk? Should the sample code also be checked?

Anything consumed by .\pom.client.xml should be fixed. We're more lax about test code with bad naming, but I dont' think it's a dev burden to ensure our samples look right. . . And if we tap into the idealist in me, I'd hope that the test code also was fixed.

@chrischild
Copy link
Contributor Author

I can fix the tests as well but someone already asked me to suppress the check for them. Should I check them as well? If you're unsure, worst case scenario someone just removes the suppression and fixes them later.

@conniey
Copy link
Member

conniey commented Oct 27, 2019

@chrischild
Do you happen to have a report handy of what errors it brings up? We can keep it suppressed for now, merge this in, and create another issue to enable it/fix it.

@chrischild
Copy link
Contributor Author

47 files without any suppressions. Suppressing implementation leaves 27. Cutting out samples would reduce it down to 5.

src\main\java\com\azure\core\test\implementation\entities\HttpBinFormDataJSON.java
src\main\java\com\azure\core\test\implementation\entities\HttpBinJSON.java
src\main\java\com\azure\core\test\implementation\RestProxyTests.java
src\test\java\com\azure\core\test\implementation\RestProxyWithMockTests.java
src\test\java\com\azure\core\test\implementation\RestProxyWithMockTests.java
src\main\java\com\azure\storage\blob\implementation\BlobsImpl.java
src\main\java\com\azure\storage\blob\implementation\BlockBlobsImpl.java
src\main\java\com\azure\storage\blob\implementation\models\BlobAbortCopyFromURLHeaders.java
src\main\java\com\azure\storage\blob\implementation\models\BlobCopyFromURLHeaders.java
src\main\java\com\azure\storage\blob\implementation\models\BlobsAbortCopyFromURLResponse.java
src\main\java\com\azure\storage\blob\implementation\models\BlobsCopyFromURLResponse.java
src\main\java\com\azure\storage\blob\implementation\models\BlobSetHTTPHeadersHeaders.java
src\main\java\com\azure\storage\blob\implementation\models\BlobsSetHTTPHeadersResponse.java
src\main\java\com\azure\storage\blob\implementation\models\BlobsStartCopyFromURLResponse.java
src\main\java\com\azure\storage\blob\implementation\models\BlobStartCopyFromURLHeaders.java
src\main\java\com\azure\storage\blob\implementation\models\BlockBlobsStageBlockFromURLResponse.java
src\main\java\com\azure\storage\blob\implementation\models\BlockBlobStageBlockFromURLHeaders.java
src\main\java\com\azure\storage\blob\implementation\models\PageBlobsUploadPagesFromURLResponse.java
src\main\java\com\azure\storage\blob\implementation\models\PageBlobUploadPagesFromURLHeaders.java
src\main\java\com\azure\storage\blob\implementation\PageBlobsImpl.java
src\samples\java\com\azure\storage\blob\BlobAsyncClientJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\BlobClientJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\BlobClientJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\SetMetadataAndHTTPHeadersExample.java
src\samples\java\com\azure\storage\blob\specialized\BlobAsyncClientBaseJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\specialized\BlobAsyncClientBaseJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\specialized\BlobClientBaseJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\specialized\BlobClientBaseJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\blob\specialized\PageBlobClientJavaDocCodeSnippets.java
src\samples\java\com\azure\storage\common\credentials\SASTokenCredentialJavaDocCodeSnippets.java
src\main\java\com\azure\storage\file\implementation\FilesImpl.java
src\main\java\com\azure\storage\file\implementation\models\FileSetHTTPHeadersHeaders.java
src\main\java\com\azure\storage\file\implementation\models\FilesSetHTTPHeadersResponse.java
src\main\java\com\azure\storage\file\implementation\models\FilesUploadRangeFromURLResponse.java
src\main\java\com\azure\storage\file\implementation\models\FileUploadRangeFromURLHeaders.java
src\samples\java\com\azure\storage\file\DirectoryAsyncJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\DirectoryJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\FileAsyncJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\FileJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\FileServiceAsyncJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\FileServiceJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\ShareAsyncJavaDocCodeSamples.java
src\samples\java\com\azure\storage\file\ShareJavaDocCodeSamples.java
src\samples\java\com\azure\storage\queue\QueueAsyncJavaDocCodeSamples.java
src\samples\java\com\azure\storage\queue\QueueJavaDocCodeSamples.java
src\samples\java\com\azure\storage\queue\QueueServiceAsyncJavaDocCodeSamples.java
src\samples\java\com\azure\storage\queue\QueueServiceJavaDocCodeSamples.java

@chrischild
Copy link
Contributor Author

Just popping in to see what's happening. I was looking over the report above and noticed that the test folder also has a implementation folder under it. Should I suppress that one as well? If I do and keep all the other suppressions then there will be no naming errors.

@JonathanGiles
Copy link
Member

Just popping in to see what's happening. I was looking over the report above and noticed that the test folder also has a implementation folder under it. Should I suppress that one as well? If I do and keep all the other suppressions then there will be no naming errors.

Yes, suppress anything under implementation. Thanks.

@chrischild
Copy link
Contributor Author

OK. This means there are no changes that come from running the checkstyle right now using the suppressions test, implementation and samples. If that's fine then I'll check in the last couple changes.

@chrischild
Copy link
Contributor Author

Hello again - I checked in the last changes that were requested and haven't heard anything about the previous post I left regarding the packages I was told to suppress. At this point I think this issue is complete.

@conniey conniey merged commit 1d288c8 into Azure:master Nov 15, 2019
@conniey
Copy link
Member

conniey commented Nov 15, 2019

@chrischild I apologise for the delayed responses, I don't get updates on pushed commits. Thanks so much. :)

@chrischild
Copy link
Contributor Author

@conniey No worries. If you do find that you would like some of those packages removed from the suppressions and have those errors fixed, do not hesitate to mention me in the issue and I'll gladly take a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use consistent naming for methods/parameters.

5 participants