Sync comments

Author: mischnic

crates/napi/src/next_api/project.rs

@@ -122,15 +122,18 @@ pub struct NapiWatchOptions {
 
 #[napi(object)]
 pub struct NapiProjectOptions {
-    /// A root path from which all files must be nested under. Trying to access
-    /// a file outside this root will fail. Think of this as a chroot.
+    /// An absolute root path from which all files must be nested under. Trying to access
+    /// a file outside this root will fail, so think of this as a chroot.
+    /// E.g. `/home/user/projects/my-repo`.
     pub root_path: RcStr,
 
-    /// A path inside the root_path which contains the app/pages directories.
+    /// A path which contains the app/pages directories, relative to [`Project::root_path`].
+    /// E.g. `apps/my-app`
     pub project_path: RcStr,
 
-    /// next.config's distDir. Project initialization occurs earlier than
-    /// deserializing next.config, so passing it as separate option.
+    /// A path where to emit the build outputs, relative to [`Project::project_path`].
+    /// Corresponds to next.config.js's `distDir`.
+    /// E.g. `.next`
     pub dist_dir: RcStr,
 
     /// Filesystem watcher options.
@@ -176,15 +179,18 @@ pub struct NapiProjectOptions {
 /// [NapiProjectOptions] with all fields optional.
 #[napi(object)]
 pub struct NapiPartialProjectOptions {
-    /// A root path from which all files must be nested under. Trying to access
-    /// a file outside this root will fail. Think of this as a chroot.
+    /// An absolute root path from which all files must be nested under. Trying to access
+    /// a file outside this root will fail, so think of this as a chroot.
+    /// E.g. `/home/user/projects/my-repo`.
     pub root_path: Option<RcStr>,
 
-    /// A path inside the root_path which contains the app/pages directories.
+    /// A path which contains the app/pages directories, relative to [`Project::root_path`].
+    /// E.g. `apps/my-app`
     pub project_path: Option<RcStr>,
 
-    /// next.config's distDir. Project initialization occurs earlier than
-    /// deserializing next.config, so passing it as separate option.
+    /// A path where to emit the build outputs, relative to [`Project::project_path`].
+    /// Corresponds to next.config.js's `distDir`.
+    /// E.g. `.next`
     pub dist_dir: Option<Option<RcStr>>,
 
     /// Filesystem watcher options.

packages/next/src/build/swc/types.ts

@@ -348,17 +348,20 @@ export interface ProjectOptions {
   /**
    * An absolute root path from which all files must be nested under. Trying to access
    * a file outside this root will fail, so think of this as a chroot.
-   * E.g. `/home/user/projects/my-repo`. */
+   * E.g. `/home/user/projects/my-repo`.
+   */
   rootPath: string
 
   /**
-   * A path which contains the app/pages directories, relative to [`Project::root_path`].
+   * A path which contains the app/pages directories, relative to `root_path`.
    * E.g. `apps/my-app`
    */
   projectPath: string
 
   /**
-   * The path to the .next directory.
+   * A path where to emit the build outputs, relative to [`Project::project_path`].
+   * Corresponds to next.config.js's `distDir`.
+   * E.g. `.next`
    */
   distDir: string