Skip to content

Conversation

@folouiseAWS
Copy link

@folouiseAWS folouiseAWS commented Dec 18, 2025

Before:
before

after:about

  • Add recursive _make_keys_human_readable method to transform nested dict keys
  • Add unit tests for the key transformation function

This fix ensures nested structures like deadline_dep_versions and additional_info have human-readable keys at all levels.

What was the problem/requirement? (What/Why)

The about page had snake case. This isn't user friendly

What was the solution? (How)

Transform keys into human readable keys

What is the impact of this change?

It is more user friendly

How was this change tested?

Manually
See DEVELOPMENT.md for information on running tests.

  • Have you run the unit tests? yes
  • Have you run the integration tests? yes
  • Have you made changes to the download or asset_sync modules? If so, then it is highly recommended
    that you ensure that the Docker-based unit tests pass.

Was this change documented?

No

  • Are relevant docstrings in the code base updated?
  • Has the README.md been updated? If you modified CLI arguments, for instance.

Does this PR introduce new dependencies?

No
This library is designed to be integrated into third-party applications that have bespoke and customized deployment environments. Adding dependencies will increase the chance of library version conflicts and incompatabilities. Please evaluate the addition of new dependencies. See the Dependencies section of DEVELOPMENT.md for more details.

  • This PR adds one or more new dependency Python packages. I acknowledge I have reviewed the considerations for adding dependencies in DEVELOPMENT.md.
  • This PR does not add any new dependencies.

Is this a breaking change?

A breaking change is one that modifies a public contract in a way that is not backwards compatible. See the
Public Contracts section
of the DEVELOPMENT.md for more information on the public contracts.

If so, then please describe the changes that users of this package must make to update their scripts, or Python applications.

Does this change impact security?

  • Does the change need to be threat modeled? For example, does it create or modify files/directories that must only be readable by the process owner?
    • If so, then please label this pull request with the "security" label. We'll work with you to analyze the threats.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@folouiseAWS folouiseAWS requested a review from a team as a code owner December 18, 2025 00:33
@github-actions github-actions bot added the waiting-on-maintainers Waiting on the maintainers to review. label Dec 18, 2025
karthikbekalp
karthikbekalp previously approved these changes Dec 18, 2025
- Add recursive _make_keys_human_readable method to transform nested dict keys
- Add unit tests for the key transformation function

This fix ensures nested structures like deadline_dep_versions and
additional_info have human-readable keys at all levels.

Signed-off-by: Louise Fox <[email protected]>
@folouiseAWS folouiseAWS force-pushed the human_readable_about_keys branch 2 times, most recently from 536efbf to 3cd8893 Compare December 18, 2025 17:34
@folouiseAWS folouiseAWS force-pushed the human_readable_about_keys branch from 3cd8893 to ddfbad5 Compare December 18, 2025 17:46
@sonarqubecloud
Copy link

@moorec-aws moorec-aws removed the waiting-on-maintainers Waiting on the maintainers to review. label Dec 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants