docs(schema): clarify that declareConstructor is not for transformations

[gcanti]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a034982

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

Bundle Size Analysis

File Name	Current Size	Previous Size	Difference
basic.ts	6.69 KB	6.69 KB	0.00 KB (0.00%)
batching.ts	8.86 KB	8.86 KB	0.00 KB (0.00%)
brand.ts	6.32 KB	6.32 KB	0.00 KB (0.00%)
cache.ts	9.94 KB	9.94 KB	0.00 KB (0.00%)
config.ts	16.95 KB	16.95 KB	0.00 KB (0.00%)
differ.ts	15.33 KB	15.33 KB	0.00 KB (0.00%)
http-client.ts	19.77 KB	19.77 KB	0.00 KB (0.00%)
logger.ts	9.15 KB	9.15 KB	0.00 KB (0.00%)
metric.ts	8.54 KB	8.54 KB	0.00 KB (0.00%)
optic.ts	7.57 KB	7.57 KB	0.00 KB (0.00%)
pubsub.ts	13.76 KB	13.76 KB	0.00 KB (0.00%)
queue.ts	11.03 KB	11.03 KB	0.00 KB (0.00%)
schedule.ts	10.22 KB	10.22 KB	0.00 KB (0.00%)
schema-representation-roundtrip.ts	24.66 KB	24.66 KB	0.00 KB (0.00%)
schema-string-transformation.ts	11.87 KB	11.87 KB	0.00 KB (0.00%)
schema-string.ts	10.19 KB	10.19 KB	0.00 KB (0.00%)
schema-template-literal.ts	12.80 KB	12.80 KB	0.00 KB (0.00%)
schema-toArbitraryLazy.ts	17.02 KB	17.02 KB	0.00 KB (0.00%)
schema-toCodeDocument.ts	19.70 KB	19.70 KB	0.00 KB (0.00%)
schema-toCodecJson.ts	16.19 KB	16.19 KB	0.00 KB (0.00%)
schema-toEquivalence.ts	16.18 KB	16.18 KB	0.00 KB (0.00%)
schema-toFormatter.ts	16.02 KB	16.02 KB	0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts	18.54 KB	18.54 KB	0.00 KB (0.00%)
schema-toRepresentation.ts	16.59 KB	16.59 KB	0.00 KB (0.00%)
schema.ts	15.65 KB	15.65 KB	0.00 KB (0.00%)
stm.ts	11.89 KB	11.89 KB	0.00 KB (0.00%)
stream.ts	9.23 KB	9.23 KB	0.00 KB (0.00%)

[github-actions]

📊 JSDoc Documentation Analysis

📈 Current Analysis Results

Analyzing 135 TypeScript files in packages/effect/src/ (including schema and config subdirectories)...

============================================================
         EFFECT JSDOC ANALYSIS REPORT
============================================================

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 135
Total exported members: 4270
Missing @example: 2137 (50.0%)
Missing @category: 403 (9.4%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. Schema.ts
   📝 489 missing examples, 🏷️  213 missing categories
   📦 489 total exports
2. Array.ts
   📝 135 missing examples, 🏷️  2 missing categories
   📦 140 total exports
3. SchemaRepresentation.ts
   📝 96 missing examples, 🏷️  12 missing categories
   📦 96 total exports
4. SchemaAST.ts
   📝 77 missing examples, 🏷️  21 missing categories
   📦 77 total exports
5. Cause.ts
   📝 79 missing examples, 🏷️  2 missing categories
   📦 79 total exports
6. Channel.ts
   📝 81 missing examples, 🏷️  0 missing categories
   📦 152 total exports
7. Option.ts
   📝 66 missing examples, 🏷️  3 missing categories
   📦 66 total exports
8. Sink.ts
   📝 64 missing examples, 🏷️  2 missing categories
   📦 81 total exports
9. SchemaTransformation.ts
   📝 37 missing examples, 🏷️  26 missing categories
   📦 37 total exports
10. Predicate.ts
   📝 57 missing examples, 🏷️  0 missing categories
   📦 57 total exports
11. SchemaGetter.ts
   📝 49 missing examples, 🏷️  0 missing categories
   📦 49 total exports
12. Result.ts
   📝 46 missing examples, 🏷️  0 missing categories
   📦 46 total exports
13. Config.ts
   📝 35 missing examples, 🏷️  6 missing categories
   📦 35 total exports
14. Types.ts
   📝 38 missing examples, 🏷️  0 missing categories
   📦 38 total exports
15. Effect.ts
   📝 31 missing examples, 🏷️  2 missing categories
   📦 253 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Chunk.ts (86 exports)
   Clock.ts (5 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   HKT.ts (4 exports)
   HashMap.ts (44 exports)
   HashSet.ts (21 exports)
   Match.ts (57 exports)
   MutableRef.ts (17 exports)
   NonEmptyIterable.ts (3 exports)
   Random.ts (9 exports)
   Redacted.ts (9 exports)
   RegExp.ts (3 exports)
   Symbol.ts (1 exports)
   Trie.ts (29 exports)
   TxChunk.ts (22 exports)
   TxDeferred.ts (7 exports)
   TxHashMap.ts (41 exports)
   TxHashSet.ts (24 exports)
   TxPriorityQueue.ts (19 exports)
   TxReentrantLock.ts (17 exports)
   TxRef.ts (7 exports)
   TxSemaphore.ts (14 exports)
   TxSubscriptionRef.ts (12 exports)
   Unify.ts (8 exports)
   index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM Schema.ts
-----------------------------------
   Optionality (type, line 150): missing example, category
   Mutability (type, line 159): missing example, category
   ConstructorDefault (type, line 169): missing example, category
   MakeOptions (interface, line 182): missing example, category
   Bottom (interface, line 210): missing example, category
   declareConstructor (interface, line 268): missing example
   declareConstructor (function, line 334): missing example
   declare (interface, line 361): missing example
   declare (function, line 392): missing example
   revealBottom (function, line 432): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 1106 missing examples, 122 missing categories
interface: 329 missing examples, 90 missing categories
type: 250 missing examples, 79 missing categories
function: 345 missing examples, 91 missing categories
namespace: 48 missing examples, 20 missing categories
class: 59 missing examples, 1 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 2133/4270 (50.0% complete)
Categories: 3867/4270 (90.6% complete)

============================================================
Analysis complete! 2540 items need attention.
============================================================

📄 Detailed results saved to: jsdoc-analysis-results.json

---

This comment is automatically updated on each push. View the analysis script for details.