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

Add documentation for enum predicate methods #816

Merged
merged 8 commits into from
Feb 6, 2025

Conversation

stephannv
Copy link

straight-shoota and others added 2 commits January 14, 2025 14:44
Add "Question methods" section and add a different example to Methods section
Copy link

netlify bot commented Feb 2, 2025

Deploy Preview for crystal-book ready!

Name Link
🔨 Latest commit aedbcff
🔍 Latest deploy log https://app.netlify.com/sites/crystal-book/deploys/67a3bd21c47c15000767d583
😎 Deploy Preview https://deploy-preview-816--crystal-book.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@straight-shoota straight-shoota changed the title Update enum.md docs Add question methods to enum documentation Feb 2, 2025
@straight-shoota straight-shoota changed the base branch from master to release/1.15 February 3, 2025 16:35
@straight-shoota
Copy link
Member

I changed the target branch to release/1.15 and thus had to revert one commit that it is master but not latest release.

@Fryguy
Copy link
Contributor

Fryguy commented Feb 3, 2025

Very minor, but would "Predicate methods" be a better title for the section?

@stephannv
Copy link
Author

Very minor, but would "Predicate methods" be a better title for the section?

I prefer "Predicate methods" but in https://crystal-lang.org/api/1.15.0/Enum.html#question-methods the used term is "Question methods". So I kept the same name.

@straight-shoota
Copy link
Member

I agree that predicate methods is formally a better term. I'd be happy to change it in both places.

Question method also has some benefit as it's very descriptive and easily understandable though 🤔

@ysbaddaden
Copy link
Contributor

I prefer "Predicate Methods".

Copy link
Member

@straight-shoota straight-shoota left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do predicate methods then!

@straight-shoota straight-shoota changed the title Add question methods to enum documentation Add predicate methods to enum documentation Feb 5, 2025
@straight-shoota straight-shoota changed the title Add predicate methods to enum documentation Add documentation for enum predicate methods Feb 6, 2025
@straight-shoota straight-shoota merged commit 1cc1d8f into crystal-lang:release/1.15 Feb 6, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants