-
Notifications
You must be signed in to change notification settings - Fork 112
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
Update composition-functions.md #774
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Let's wait for the 1.16 docs to publish in #773 before merging |
@plumbis PTAL - I improved wording to address a passive voice lint check |
Please overrule the lint check. It is not helping in this case. |
This can be done within your changes as described in the contributing guide: https://docs.crossplane.io/contribute/vale/#ignore-vale-rules want to give that a try with another commit @joebowbeer? |
Signed-off-by: Joe Bowbeer <[email protected]>
@jbw976 PTAL - passive voice lint rule selectively disabled By the way, as an author and technical reviewer, I could not function without passive voice. I think Robert Delwood makes some good points in this article: There is No You in API: A Case for Passive Voice in API Documentation
|
Thanks @joebowbeer for both the contribution and the good article about passive voice! that was an interesting read. it's good to have the option to use passive voice when it makes more sense and it looks like there are a good number of those exceptions in this docs repo already. the more writer/author inclined maintainers on this repo can consider if more relaxed rules would be better for a new default, but I have a feeling that keeping the default as is and allowing exceptions when needed is a reasonable compromise :) |
Fix several nits in the composition functions doc.
Also fixed a couple typos in the vale config file comments.