From 2f0c810c492494165eab211b7025f31ea3f5792a Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Sat, 11 Jul 2020 18:15:40 +0800 Subject: [PATCH] docs(`valid-types`): clarify throws as having an optional type, not namepath --- .README/rules/valid-types.md | 7 ++++--- README.md | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.README/rules/valid-types.md b/.README/rules/valid-types.md index 2c2b87d6c..36082204c 100644 --- a/.README/rules/valid-types.md +++ b/.README/rules/valid-types.md @@ -25,8 +25,9 @@ Also impacts behaviors on namepath (or event)-defining and pointing tags: 1. Name(path)-pointing tags (which may have value without namepath or their namepath can be expressed elsewhere on the block): `@listens`, `@fires`, `@emits`, and `@modifies` (an undocumented jsdoc tag) -1. Name(path)-pointing tags which may have free text or a namepath: - `@throws`, `@see` +1. Name(path)-pointing tags which may have free text or...: + 1. a type (`@throws`) + 1. a namepath (`@see`) 1. Name(path)-pointing tags (multiple names in one): `@borrows` ...with the following applying to the above sets: @@ -48,7 +49,7 @@ Also impacts behaviors on namepath (or event)-defining and pointing tags: #### Options -- `allowEmptyNamepaths` (default: true) - Set to `false` to disallow +- `allowEmptyNamepaths` (default: true) - Set to `false` to bulk disallow empty name paths with groups 2 and 4 (these might often be expected to have an accompanying name path, though they have some indicative value without one; these may also allow names to be defined in another manner elsewhere diff --git a/README.md b/README.md index 4cb494c64..d6f2d70b8 100644 --- a/README.md +++ b/README.md @@ -13515,8 +13515,9 @@ Also impacts behaviors on namepath (or event)-defining and pointing tags: 1. Name(path)-pointing tags (which may have value without namepath or their namepath can be expressed elsewhere on the block): `@listens`, `@fires`, `@emits`, and `@modifies` (an undocumented jsdoc tag) -1. Name(path)-pointing tags which may have free text or a namepath: - `@throws`, `@see` +1. Name(path)-pointing tags which may have free text or...: + 1. a type (`@throws`) + 1. a namepath (`@see`) 1. Name(path)-pointing tags (multiple names in one): `@borrows` ...with the following applying to the above sets: @@ -13539,7 +13540,7 @@ Also impacts behaviors on namepath (or event)-defining and pointing tags: #### Options -- `allowEmptyNamepaths` (default: true) - Set to `false` to disallow +- `allowEmptyNamepaths` (default: true) - Set to `false` to bulk disallow empty name paths with groups 2 and 4 (these might often be expected to have an accompanying name path, though they have some indicative value without one; these may also allow names to be defined in another manner elsewhere