style(typegoose): add link to mongoose issue for "Passthrough" class

typegoose · Jul 30, 2021 · 3fd6f4f · 3fd6f4f
1 parent d022340
commit 3fd6f4f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/api/decorators/prop.md b/docs/api/decorators/prop.md
@@ -786,7 +786,7 @@ It is not recommended to use this class, it should always be another class if ne
 The `Passthrough` class is, like the name implies, to pass-through an schema definition directly, without "wrapping" it in a `new Schema({}` call.
 
 :::note
-It should be noted that using this method (even in plain mongoose) will result in these paths to become `mongoose.Schema.Types.Mixed`, and also no typegoose transformations or warnings will be applied to what is inside `Passthrough` (like `type: () => Class` will not be translated, it will stay as-is)
+It should be noted that using this method (even in plain mongoose) will result in these paths to become `mongoose.Schema.Types.Mixed` (see [Mongoose#7181](https://github.com/Automattic/mongoose/issues/7181)), and also no typegoose transformations or warnings will be applied to what is inside `Passthrough` (like `type: () => Class` will not be translated, it will stay as-is)
 :::
 
 The following example is what it looks like in typegoose, and what it would look like in plain mongoose:

diff --git a/src/typegoose.ts b/src/typegoose.ts
@@ -294,7 +294,7 @@ export function getDiscriminatorModelForClass<U extends AnyParamConstructor<any>
 /**
  * Use this class if raw mongoose for this path is wanted
  * It is still recommended to use the typegoose classes directly for full type and validation support
- * Note: using this, paths are of type "Mixed" (with some validation)
+ * @see Using `Passthrough`, the paths created will result in `Mixed`, see {@link https://github.com/Automattic/mongoose/issues/7181 Mongoose#7181}
  * @example
  * ```ts
  * class Dummy {