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

Cleanup invalid variable examples from doc #8306

Closed
medikoo opened this issue Sep 30, 2020 · 6 comments · Fixed by #11785
Closed

Cleanup invalid variable examples from doc #8306

medikoo opened this issue Sep 30, 2020 · 6 comments · Fixed by #11785

Comments

@medikoo
Copy link
Contributor

medikoo commented Sep 30, 2020

As reported here #8279 (comment) we have some invalid variable examples in doc as ${self:} and ${env:}.

I've learned they're not invalid still they're controversial, and use case feels dubious. I would definitely not market them, simply to not confuse. So let's remove them from documentation.

@dsuarezlogans
Copy link

Hello good day, can I help with this issue?

@medikoo
Copy link
Contributor Author

medikoo commented Oct 2, 2020

@dsuarezlogans Hello, certainly, that'll be very welcome!

@dsuarezlogans
Copy link

@medikoo for me to be clear on what is required, I need to remove the ${self:} and ${env:} parts of the variables in documentation for each provider right? like in here

@medikoo
Copy link
Contributor Author

medikoo commented Oct 5, 2020

I've learned today,that this notation is actually valid, still it's controversial, and I would still not use it in examples.

So yes, it's about removing it from docs, but it should not be removed if it's the place where this specific notation is documented (I think we don't have such place, but I write this just in case)

@medikoo medikoo added enhancement and removed bug labels Oct 5, 2020
@sleepwithcoffee
Copy link
Contributor

Hi @medikoo just want to check if this is still open and valid? I might be able to help

@medikoo
Copy link
Contributor Author

medikoo commented Mar 9, 2023

@duytrandev Yes I believe it's valid. PR's welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants