Mirror of forum.nim-lang.org

3959 :: Naming conventions for modules?

• jyapayne (orginal) [2018-06-21T11:35:20+02:00] view original

  What is the recommended way to name multi-word modules? For example, if I have a module I want to call swap members, do I use swapMembers.nim or swap_members.nim or something else? It's just an example but I've been curious for a while.

---

• Araq (orginal) [2018-06-21T12:20:41+02:00] view original

  I don't know if NEP-1 says anything about it, but I use alllower, mostly without underscores.

---

• jyapayne (orginal) [2018-06-21T12:52:14+02:00] view original

  Isn't that a bit hard to look at though in some cases? Like when I quickly glance at alllower I read it as allower, as in one who allows. I did look at NEP-1 and I didn't find anything about modules :(

---

• Araq (orginal) [2018-06-21T14:58:46+02:00] view original

  Well if it's too hard to look at, I use underscores (or pick a different name).

---

• Arrrrrrrrr (orginal) [2018-06-21T20:31:59+02:00] view original

  I use for modules the same convetion than for types, ie MyModule.

---

• jyapayne (orginal) [2018-06-22T06:33:30+02:00] view original

  Okay, those both sound reasonable. Just wondering if there was a consensus :)

---

• andrea (orginal) [2018-06-22T09:49:32+02:00] view original

  I use swap_members.nim :-)

---

• twetzel59 (orginal) [2018-06-23T02:11:06+02:00] view original

  Looks like the convention is no spaces, all lowercase, no underscores. Examples: sharedtables, httpserver, nativesockets, xmldomparser.

  If you feel it's unreadable, I agree with @andrea, and say use underscores, because to me the capitalization consistency is most important. All module names are lowercase, so underscores seem like the "least unexpected" solution :)

---

• jyapayne (orginal) [2018-06-23T02:21:10+02:00] view original

  Cool :) I'll go with that then. Thanks everyone!

---