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

Drop Exercises from the module name #17

Closed
waseem-medhat opened this issue Nov 22, 2024 · 1 comment · Fixed by #18
Closed

Drop Exercises from the module name #17

waseem-medhat opened this issue Nov 22, 2024 · 1 comment · Fixed by #18
Assignees

Comments

@waseem-medhat
Copy link
Collaborator

waseem-medhat commented Nov 22, 2024

Module names are kinda unwieldy (e.g., one function call looks like this Spirit.Exercises.BinariesStringsAndCharlists.describe_string(s)). So, I suggest we update our structure to mitigate this by replacing the directory name from exercises to just spirit. I've shown it in detail below to make it clear.

Directory structure:

  • Before: lib/exercises/binaries_strings_and_charlists.ex
  • After: lib/spirit/binaries_strings_and_charlists.ex

Module name:

  • Before: Spirit.Exercises.BinariesStringsAndCharlists
  • After: Spirit.BinariesStringsAndCharlists

An added bonus is that this structure is probably more idiomatic since LSP completion now detects the module name correctly when I use the defmodule snippet.

@waseem-medhat waseem-medhat converted this from a draft issue Nov 22, 2024
@nikfp
Copy link
Member

nikfp commented Nov 22, 2024

I agree that this makes more sense overall. And since having it work with existing tooling is one of our primary goals I think this chance makes sense from an LSP standpoint as well.

@waseem-medhat waseem-medhat self-assigned this Nov 22, 2024
@waseem-medhat waseem-medhat moved this from In Progress to Done in Spirit Kanban Dec 1, 2024
@waseem-medhat waseem-medhat closed this as completed by moving to Done in Spirit Kanban Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants