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

ELY-2379 Rename a local variable in FileAuditEndpoint class [local_variable_renamed] #2059

Conversation

OluchukwuCatherineObi-Njoku
Copy link
Contributor

Copy link
Contributor

@Skyllarr Skyllarr left a comment

Choose a reason for hiding this comment

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

Hi @OluchukwuCatherineObi-Njoku , thank you for the PR! I added some feedback

@@ -70,22 +70,22 @@ public class FileAuditEndpoint implements AuditEndpoint {
}

void setFile(final File file) throws IOException {
boolean ok = false;
boolean isSetUp = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

@OluchukwuCatherineObi-Njoku Please rename to for example isFileSet or fileSet to be more specific about what has been set

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello. I made the suggested updates. Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello. I made the suggested updates. Thanks

@Skyllarr

@@ -108,7 +108,7 @@ private void safeClose(Closeable c) {
* This method can be overridden by subclasses to modify data written into file (to encrypt them for example),
* or just for counting amount of written bytes for needs of log rotation and similar.
*
* This method can be invoked only in synchronization block surrounding one log message processing.
* This method can be invisSetUped only in synchronization block surrounding one log message processing.
Copy link
Contributor

Choose a reason for hiding this comment

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

@OluchukwuCatherineObi-Njoku This should not have been renamed, same goes for line 124

@PrarthonaPaul
Copy link
Contributor

Hi @OluchukwuCatherineObi-Njoku
Just a reminder, there are some comments on this PR that need to be addressed.
If you have any questions about any of the comments, please feel free to let us know :)

Copy link
Contributor

@fjuma fjuma left a comment

Choose a reason for hiding this comment

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

Thanks for the updates @OluchukwuCatherineObi-Njoku! Just one more spot where a word shouldn't be updated.

@@ -121,7 +121,7 @@ void write(String toWrite) throws IOException {
* This method is NO-OP by default. It is intended to be overridden by subclasses
* which need to perform some operation before every writing into the target local file.
*
* This method can be invoked only in synchronization block surrounding one log message processing.
* This method can be invisFileSeted only in synchronization block surrounding one log message processing.
Copy link
Contributor

Choose a reason for hiding this comment

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

This shouldn't be renamed.

@darranl
Copy link
Contributor

darranl commented Mar 14, 2024

Thank you for your PR FYI I have just submitted #2112 to correct the comment update that crept in with this PR.

@darranl darranl closed this Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants