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 callout to full bitstring reference in the getting started guide. #13360

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Conversation

Moosieus
Copy link
Contributor

The bitstring constructor syntax reference <<>> isn't easy for newcomers to discover. It's not SEO friendly and the getting started guide for bitstrings doesn't indicate that subtle link's the full reference.

The old getting started guide on elixir-lang.org called out to it in plain English, and I think it's worth adding back in some form.

I've added it back in this PR at the bottom of the bitstring section in bold, in addition to removing the /1 from the <<>>/1 link at the top.

My impetus for this is, I saw a new person asking questions about bitstrings. They'd already been working with them a fair bit, going off blog posts and the getting started guide. They weren't aware the full syntax reference was available. Purely an anecdotal case, but I thought this worth proposing nonetheless.

@josevalim josevalim merged commit c1b54c6 into elixir-lang:main Feb 22, 2024
1 check failed
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

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

Successfully merging this pull request may close these issues.

2 participants