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

Add documentation about the combined use of $globals and $runtime_params #3706

Closed
noklam opened this issue Mar 13, 2024 · 2 comments
Closed
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@noklam
Copy link
Contributor

noklam commented Mar 13, 2024

Description

Read #2531 for the full context.

There are many questions asked in the slack such as "how to override global with runtime parameters", we explicitly block this but we don't have the reason document.

The docs should document 2 things:

  1. The rationale of the design, WHY we block this
  2. How to do this in the preferred way (nested globals{xxx, {$runtime_param}))

Documentation page (if applicable)

(Try to search from the console see if you can find the section easily with keywords)

Possible solution

Summary #2531, the discussion was mostly documented already in the issue, we just need to make that available in docs.

@noklam noklam added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Mar 13, 2024
@datajoely
Copy link
Contributor

@noklam
Copy link
Contributor Author

noklam commented Mar 25, 2024

Make sure to read #2531 for the discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

No branches or pull requests

4 participants