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

Property Aliases documentation #8656

Open
mjingle opened this issue Jun 12, 2019 · 2 comments

Comments

Projects
None yet
3 participants
@mjingle
Copy link
Contributor

commented Jun 12, 2019

Describe the Enhancement:

Currently, property aliases are not documented for chef/chef. (See this example of aliases.) Ideally, this gap in documentation should be fixed.

Describe the Need:

Property aliases may be something that users use, yet users are not able to cross-reference within the docs.

Current Alternative:

Currently, property aliases can be found in the code, but not in the docs. It's just something that magically works for folks.

Can We Help You Implement This?:

Please determine if documenting property aliases is something to invest time in. Another factor in this decision is how to automate the documentation of property aliases if the answer is yes.

@lamont-granquist

This comment has been minimized.

Copy link
Contributor

commented Jun 13, 2019

That isn't a "property alias", that is just a ruby alias of the method. Maybe the aliases could be added to the property itself, but that particular ruby statement can't really be extended itself in any way.

@tas50

This comment has been minimized.

Copy link
Member

commented Jun 13, 2019

Yeah the point was that we're just using the method aliases and those aren't known by chef in any way. We probably need a "chef way" of doing this in the resource class that allows us to bubble up aliases in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.