Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Generators, simplifies storage of txt that is codeEscaped vs htmlEscaped [breaking] #315

Merged
merged 14 commits into from
Dec 4, 2023

Conversation

spacether
Copy link
Contributor

@spacether spacether commented Dec 4, 2023

Generators, simplifies storage of txt that is codeEscaped vs htmlEscaped
For documentation on often wants to render text that is html escaped one can do that with {{originalTxt}}
or show the unescaped original content with
{{{originalTxt}}}
And when writing code one want to render txt that it is code escaped like so:
some_variable = {{{codeEscaped}}}

So I am making a java class CodegenText to store properties original and codeEscaped to store values that can be used in those above use cases.

Breaking Change with Fallback

  • this is a breaking change with fallback for templates that used description and unescapedDescription
  • if one depended on the old string variables, one can switch to the dot method access to get the expected values

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    mvn clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/python*.
    For Windows users, please run the script in Git BASH.

@spacether spacether merged commit 2cf2ad0 into master Dec 4, 2023
@spacether spacether deleted the feat_simplifies_txt_storage branch December 4, 2023 05:15
@spacether spacether changed the title Generators, simplifies storage of txt that is codeEscaped vs htmlEscaped Generators, simplifies storage of txt that is codeEscaped vs htmlEscaped [breaking] Jan 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant