Mummy likes better docs~ #41
Conversation
|
incoming changes may affect these docs: #43 mommy will review this in the morning, thank you for your patience~ |
There was a problem hiding this comment.
A lot of good stuff in here! Most of my concerns are with the order information is presented in. For instance, it's weird to explain how to get a value first when the user is primarily interested in setting them (and can't possibly have any set yet). Explaining how to set, and then showing how to check it worked, would make more sense.
I'm approving this now, but lmk if you want to do revisions. If you don't I can do my own followup passes.
|
|
||
| You can see all of your current settings by running `export -p | grep CARGO_MOMMY`. | ||
|
|
||
| Depending on the one you have, you'll have to modify the contents of your rcfile (with [vim](https://github.com/vim/vim), [nano](https://nano-editor.org/), [helix](https://github.com/helix-editor/helix) etc.), or create one if it doesn't exist. |
There was a problem hiding this comment.
I think it's a little excessive to tell a rust programmer how to edit a text file. X3
| export CARGO_MOMMYS_MOODS="chill/thirsty" | ||
| ``` | ||
|
|
||
| To remove any of the settings, simply delete the associated line in the file. |
There was a problem hiding this comment.
Interesting that you call out bashrc and zshenv but not the most-generic ~/.profile. I know you sometimes HAVE to use those two files, but idk how many shells don't look at either but do look at ~/.profile. I do know fish doesn't look at any of the 3, making it the hardest to doc/support. X3
| Change `~/.bashrc` to include your settings. Set them with `export VAR_NAME=value`, for example: | ||
|
|
||
| ```sh | ||
| $ cat ~/.bashrc |
There was a problem hiding this comment.
probably it would be simpler to just show the contents of the file once (since it's the same thing regardless of file). Also including the cat expression might be confusing (might make them think they should be adding that to the file).
| > set | find "CARGO_MOMMY" | ||
| ``` | ||
|
|
||
| - For Powershell (now might be a good time to learn the difference between Windows `powershell.exe` and Microsoft `pwsh.exe`): |
There was a problem hiding this comment.
Wait is it? What's the difference they should know? I would have thought pwsh vs cmd would be a bigger concern.
|
aight i'll make a few revisions and get back to ya |
|
fyi i had another Being Extremely Normal day and wrote a new cargo-mommy book https://faultlore.com/cargo-mommy/book/ I did my best to preserve the README around your PR to avoid conflicts (seems like it worked!) and left two potential places for your docs (because i really am TERRIBLE at env-var stuff lol): |
|
hehe saw your tweets about the book, loving it so far my laptop inhaled a bit of steam and the motherboard is fried, so i haven’t been able to work on anything so far…i think i’ll be up and running by this weekend but if anyone in the meantime wants to flesh it out then that’ll be cool |
This adds documentation (a bit too much, even) on how to set things with env. vars. on most OSes (Darwin, NT, Linux)