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

[Feedback]: Highlight mandatory parameters required in definition of user defined actions #3729

Open
Joyfred opened this issue Jan 20, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation feedback Submissions from the docs site feedback form

Comments

@Joyfred
Copy link

Joyfred commented Jan 20, 2025

Is it easy to find the information you need?

Yes

Are the instructions clear?

Yes

How could we improve the Timescale documentation site?

While defining user defined actions (jobs), based on this page
users tend to create functions like:

CREATE FUNCTION func()

instead of

CREATE FUNCTION func(job_id INT DEFAULT NULL, config JSONB DEFAULT NULL)

which leads to errors. It'd be great if you can somehow highlight that these arguments are mandatory to added, while defining functions for jobs

@Joyfred Joyfred added documentation Improvements or additions to documentation feedback Submissions from the docs site feedback form labels Jan 20, 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 feedback Submissions from the docs site feedback form
Projects
None yet
Development

No branches or pull requests

1 participant