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

Creating a new Julia environment is perhaps not so clear #97

Open
HannoSpreeuw opened this issue Jan 15, 2025 · 1 comment
Open

Creating a new Julia environment is perhaps not so clear #97

HannoSpreeuw opened this issue Jan 15, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@HannoSpreeuw
Copy link
Contributor

The REPL paragraph in the documentation says:

If you want to experiment with things, try to create a new environment 
in an empty folder and add CarboKitten as a dev dependency

Perhaps it is not so clear for a lot of users how to create a new environment in Julia.

Or you could consider that not part of this documentation and people should figure it out using the Julia documentation.

@HannoSpreeuw HannoSpreeuw added the documentation Improvements or additions to documentation label Jan 15, 2025
@HannoSpreeuw HannoSpreeuw self-assigned this Jan 15, 2025
@EmiliaJarochowska
Copy link
Member

Reading this, it is not clear to me why one should do it. After all, it is a CarboKitten documentation, not a Julia course. So I think it should stick to commands needed to run CarboKitten.
So I would rephrase this:

Additionally you should learn how to work with Julia packages.

to

Running CarboKitten will require to load other dependencies, so please consult the documentation on Julia packages to learn how.

Writing "you should learn to" may come across as a bit patronizing, and our users will be already humiliated enough, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants