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

Update help text for COM and TITLE parameters #5122

Open
sergei-maertens opened this issue Feb 26, 2025 · 1 comment
Open

Update help text for COM and TITLE parameters #5122

sergei-maertens opened this issue Feb 26, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation owner: den-haag
Milestone

Comments

@sergei-maertens
Copy link
Member

Thema / Theme

Admin

Omschrijving / Description

The available variable public_reference is documented, but it would be better to document this as {{ public_reference }} to make the template syntax clear, since the general configuration uses a different format (single curly braces).

Added value / Toegevoegde waarde

Reduce confusion

Aanvullende opmerkingen / Additional context

Direct .format calls/syntax should be avoided, so the general configuration is "wrong" here - instead this should be passed through the sandbox template engine, but that would be a breaking change.

@sergei-maertens sergei-maertens added enhancement owner: den-haag triage Issue needs to be validated. Remove this label if the issue considered valid. labels Feb 26, 2025
@joeribekker joeribekker added documentation Improvements or additions to documentation and removed triage Issue needs to be validated. Remove this label if the issue considered valid. labels Mar 3, 2025
@joeribekker
Copy link
Contributor

joeribekker commented Mar 3, 2025

Refinement: Replace public_reference with {{ public_reference }} in model help_text and/or readthedocs. If its more/harder than this, let me know.

@joeribekker joeribekker added this to the Release 3.1.0 milestone Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation owner: den-haag
Projects
Status: Todo
Development

No branches or pull requests

3 participants