Clojush icon indicating copy to clipboard operation
Clojush copied to clipboard

Clarify shell and REPL commands' treatment of underscores vs hyphens

Open Vaguery opened this issue 10 years ago • 7 comments

I notice (after getting enigmatic errors) that the name of a clojure file that has underscores is (at least sometimes) "supposed" to have hyphens instead when you invoke it from lein run or inside a REPL with (use 'thingie-with-hyphens).

That should be made explicit.

Vaguery avatar Feb 20 '15 23:02 Vaguery

This is a Clojure namespace thing, not a Clojush thing. Clojure files are supposed to use underscores, where the namespaces are supposed to be equivalent except replacing underscores with hyphens. lein run asks you prescribe a namespace to run, which therefore uses hyphens. So: always use hyphens in namespaces, underscores in filenames.

Again, "Java or something".

thelmuth avatar Feb 21 '15 15:02 thelmuth

I think on the subject of "people using it" we should probably explicitly mention it in the docs. Since the docs specify an example/demo that doesn't have underscores, it caught me unawares.

Again, these issues aren't for immediate "fixing": these are improvements to consider in future releases and versions.

Vaguery avatar Feb 21 '15 17:02 Vaguery

Lee or somebody, could we have some labels for issues?

Vaguery avatar Feb 22 '15 11:02 Vaguery

Uh, sure... but can you guide me re: how and maybe also give me suggested labels?

lspector avatar Feb 22 '15 13:02 lspector

View an issue on Github.

Labels can be added to any given issue (and thus the whole project) from the dropdown over on the right -> (for the project's contributors). They'll see a little gear, which will let them add one or more labels.

Good labels, in my experience, are like social media tags: "Not Now", "Show-stopper", "Urgent", "Some Day" etc, or maybe "core", "cleanup", "docs", "clarification", "feature request". Stuff like that.

It's a social thing. Like not writing shell script to automatically accept pull requests, for instance. With great power comes annoying correspondents.

Vaguery avatar Feb 22 '15 14:02 Vaguery

Thanks. Made and applied some labels. Also closed a couple of issues. Still considering those shell scripts though :-). Not to run automatically! Just to walk through the process once I know I want to accept the request, bump the version, etc.

lspector avatar Feb 22 '15 21:02 lspector

I totally think someday you'll be ready for a Continuous Integration workflow, at this rate. :)

Seriously, your "run some scripts" is basically the same as "confirm new code is rigorously tested, and make sure all automated tests before pushing" that CI practitioners do.

Vaguery avatar Feb 22 '15 22:02 Vaguery