Repository navigation
Fix inverted docstring for config write hide_sensitive option - #71623
Merged
potiuk merged 1 commit intoAug 14, 2026
Merged
Conversation
AirflowConfigParser.write() documented the flag under a name it does not have and described it as including sensitive values, while the implementation replaces them with "< hidden >". Anyone reading the docstring to decide whether a generated config file is safe to share would conclude the opposite of what the code does.
potiuk
approved these changes
Aug 14, 2026
imrichardwu
pushed a commit
to imrichardwu/airflow
that referenced
this pull request
Sep 11, 2026
…#71623) AirflowConfigParser.write() documented the flag under a name it does not have and described it as including sensitive values, while the implementation replaces them with "< hidden >". Anyone reading the docstring to decide whether a generated config file is safe to share would conclude the opposite of what the code does.
This file contains hidden or 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
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.
Sumarry
AirflowConfigParser.write()documents its masking flag as:param hide_sensitive_values: Include sensitive values in the output.Both halves are wrong. The parameter is named
hide_sensitive, and theimplementation does the opposite of what the description says:
This PR fixed the both problems of documents (The wrong name and wrong implementation description)
Just fixed documents, no any behavior be changed.