Merge pull request #33 from joshuanianji/docs-again

(docs) Fix documentation errors
joshuanianji · Jan 1, 2024 · 594c7c2 · 594c7c2
2 parents 04a1a0e + a032db4
commit 594c7c2
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/src/mount-pnpm-store/NOTES.md b/src/mount-pnpm-store/NOTES.md
@@ -2,11 +2,11 @@
 
 ### pnpm `store-dir`
 
-This is opinionated, but I dislike the pnpm store being in the workspace as it adds clutter. This feature sets the pnpm `store-dir` config to `~/.pnpm-store`, so it's out of sight. The home directory will be based on the `remoteUser` of the base image you have.
+This is opinionated, but I dislike the pnpm store being in the workspace along with your code as it adds clutter. This feature sets the pnpm `store-dir` config to `~/.pnpm-store`, so it's out of sight. The home directory will be based on the `remoteUser` of the base image you have.
 
 ### Ensuring pnpm is installed
 
-This feature does not install pnpm by itself and expects `pnpm` to be installed already, either by a base image or by a feature. It fails quietly if pnpm is not installed.
+This feature does not install pnpm by itself and expects `pnpm` to be installed already, either by a base image or by a feature. If pnpm is not installed, it just gives a warning (you'll have a random ~/.pnpm-store folder in your home directory and the pnpm `store-dir` config will not be set) but does not fail.
 
 If you are installing pnpm with a feature, you may need to ensure it is run **before** `mount-pnpm-store`. To make this work, use the [`overrideFeatureInstallOrder` property](https://containers.dev/implementors/features/#overrideFeatureInstallOrder), since the default feature installation order is based on ID (alphanumerically i think). Here is an example using `features/node`:
 

diff --git a/src/mount-pnpm-store/devcontainer-feature.json b/src/mount-pnpm-store/devcontainer-feature.json
@@ -3,7 +3,7 @@
     "id": "mount-pnpm-store",
     "version": "0.1.0",
     "documentationURL": "https://github.com/joshuanianji/devcontainer-features/tree/main/src/mount-pnpm-store",
-    "description": "Mounts the pnpm store to a volume to share between multiple devcontainers, and sets pnpm store to ~/.pnpm-store. Fails if pnpm is not installed.",
+    "description": "Mounts the pnpm store to a volume to share between multiple devcontainers, and sets pnpm store to ~/.pnpm-store.",
     "options": {},
     "mounts": [
         {