crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
47 stars 105 forks source link

Cleanup spaces in `composition-functions.md` #794

Open Moulick opened 1 week ago

Moulick commented 1 week ago

As mentioned in #793

netlify[bot] commented 1 week ago

Deploy Preview for crossplane ready!

Name Link
Latest commit 92ab3d696cb41d5d0ad54e5dfaa94193661be520
Latest deploy log https://app.netlify.com/sites/crossplane/deploys/668bd7455badc000085205f8
Deploy Preview https://deploy-preview-794--crossplane.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
1 paths audited
Performance: 88 (🟢 up 9 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (no change from production)
SEO: 93 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Moulick commented 1 week ago

@plumbis does this look ok?

plumbis commented 1 week ago

I'm hesitant to approve a whitespace cleanup PR. End of line whitespace can have meaning in markdown, creating a line return. It makes this kind of PR hard to review.

I know most of these are single space, but there is at least one instance where it's removing a line return.

Unless there's a compelling reason to do this work I'd rather close out this PR.

Moulick commented 1 week ago

I'm hesitant to approve a whitespace cleanup PR. End of line whitespace can have meaning in markdown, creating a line return. It makes this kind of PR hard to review.

I know most of these are single space, but there is at least one instance where it's removing a line return.

Unless there's a compelling reason to do this work I'd rather close out this PR.

Thanks for the review. As far as I found, a single space at the end of line does not have any meaning but double space does. From a cursory glance, I see it's broken a line return at

Function Patch and Transform implements Crossplane resource templates.
The input kind is

I can go over and compare the current rendered docs vs the whitespace removed version and add the proper breaks using
wherever the intended line break currently are.

The reason I open this PR is while making the previous PR #793, I had to do through three different markdown editors to make them not format the text on save. Finally, only the macOS built-in TextEdit was used to make the fix as it does not do any formatting at all 🤣. So, the main intention is to prevent this problem for any contributors to the docs and make them easier to contribute ❤️