[hotfix] Correct the comments for FlinkSecurityManager #26325
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
ping @hwanju @rmetzger cc @1996fanrui @davidradl @nilmadhab |
davidradl
reviewed
Mar 20, 2025
| @@ -89,8 +89,8 @@ static FlinkSecurityManager fromConfiguration(Configuration configuration) { | |||
|
|
|||
| boolean haltOnSystemExit = configuration.get(ClusterOptions.HALT_ON_FATAL_ERROR); | |||
|
|
|||
| // If no check is needed, return null so that caller can avoid setting security manager not | |||
| // to incur any runtime cost. | |||
| // If no check is needed, return null so that caller can avoid setting security manager and | |||
There was a problem hiding this comment.
nit: security manager -> the security manager
imho: I am not too worried about the text here - as the method javadoc seems to cover this. I would be inclined to remove this comment as it adds nothing to the javadoc. If we want to improve it, it would be better to have this comment explain why these if conditions indicate that we should not return a FlinkSecurityManager.
- but if we change it here we should use the same words in the methods javadoc.
There was a problem hiding this comment.
Yes, the javadoc seems good enough. I think this inner comments just for readability.
|
cc @GOODBOY008 |
|
cc @xintongsong |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This PR aim to correct the comments for
FlinkSecurityManager.The original comments means cannot avoid the overhead. It is wrong.
Brief change log
Correct the comments for
FlinkSecurityManagerVerifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (no)Documentation