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

docs: template reference #1653

Merged
merged 2 commits into from
May 16, 2024
Merged

docs: template reference #1653

merged 2 commits into from
May 16, 2024

Conversation

pd93
Copy link
Member

@pd93 pd93 commented May 12, 2024

Fixes #1614

Adds a reference for templating variables and functions to the docs. Since this makes the reference extremely long, I have also split it into 4 pages:

image

I have also added the deprecated functions to the deprecations doc so that they are not forgotten about in the future.

@pd93 pd93 changed the title template function docs docs: template reference May 12, 2024
@pd93 pd93 added the area: docs Changes related to documentation. label May 12, 2024
Copy link
Member

@andreynering andreynering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Liked the new Templating Reference docs. Separating on pages is nice, too.

| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CLI_ARGS` | Contain all extra arguments passed after `--` when calling Task through the CLI. |
| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. |
| `TASK` | The name of the current task. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before merging, add the TASK_EXE line that was added to main.

@pd93 pd93 merged commit b0efbad into main May 16, 2024
13 checks passed
@pd93 pd93 deleted the template-function-docs branch May 16, 2024 10:11
pd93 added a commit that referenced this pull request May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Changes related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Request: Docs section listing all template functions available
2 participants