Skip to content

Improve defguard/1 docs with links to guides. #13757

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

Conversation

christhekeele
Copy link
Contributor

@christhekeele christhekeele commented Aug 3, 2024

Now that we've co-located the Elixir guides with moduledocs in ex_doc, we can link directly to them in the defguard/1 @doc for:

  • more context on guards themselves
  • naming conventions for your own guards

Also normalizes the lead-in verb Defines... with defimpl/1, defprotocol/2, defexception/1, defstruct/1 and friends; and directly references the macro argument guard.

@christhekeele christhekeele force-pushed the link-defguard-to-naming-conventions branch from a7b7cd1 to a9b3745 Compare August 3, 2024 19:49
@josevalim josevalim merged commit bd92cba into elixir-lang:main Aug 3, 2024
9 checks passed
@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