-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Make clear the " alias, require, and import " also talks about use #13559
Make clear the " alias, require, and import " also talks about use #13559
Conversation
Browsing the docs I found the page and found it weird that it didn't mention use (as the 4 of them go together), reading the page I realized that it _does_ mention `use` but it's just not mentioned in the headline so this seemed like an easy fix. I did _not_ modify the file name, although I think it'd be better to also rename the file (and references to it). However, I was worried about breaking outside links to https://hexdocs.pm/elixir/alias-require-and-import.html I'm looking for guidance on: * is the breakage ok * should we just not break * should we break and maybe leave a note in the existing file that documenation moved (and hide from the getting started)
Hi @PragTob! I am not actually sure about this change. In a way, I understand that for most Elixir developers they are at the same level, but the first three are really language features while |
👋 As usual I suspected that there was some reasoning I wasn't privy to and not just an oversight 😅 My reasoning was just that what I was looking for was a comparison of the 4 (to double check my understanding before writing on it, and to link to more extensive docs) and I almost didn't read the page/was going to look for more as it didn't mention In the body it's also covered on the same level as I'm also interested in the PoV of it being a convention - since to my eyes (not a language designer/core contributor) Anyhow, that's why I thought it'd be worthwhile. As always, up to you! 🙇 💚 |
Maybe it's a good idea to split |
I'd definitely expect it there as it's the 4 ways we... I dunno... reference other modules usually at the top of our module. Imo esp. beginners wonder about when to use which one (I know I did, and lots of people I taught did to) so having them all in one page highlighting their differences totally makes sense to me :) |
💚 💙 💜 💛 ❤️ |
Browsing the docs I found the page and found it weird that it didn't mention use (as the 4 of them go together), reading the page I realized that it does mention
use
but it's just not mentioned in the headline so this seemed like an easy fix.I did not modify the file name, although I think it'd be better to also rename the file (and references to it). However, I was worried about breaking outside links to https://hexdocs.pm/elixir/alias-require-and-import.html I'm looking for guidance on:
Thanks for all your work as usual! 💚