Skip to content

Conversation

@unknown
Copy link
Contributor

@unknown unknown commented Nov 11, 2025

Type

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Fixes broken documentation for Effect.filter, Effect.filterOrElse, and Effect.filterOrFail. The predicates previously did not return Filter.fails, so the numbers were never filtered.

Related

  • Related Issue #
  • Closes #

@github-actions
Copy link

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 6.09 KB 6.08 KB +0.01 KB (+0.20%)
bundle/batching.ts 8.33 KB 8.31 KB +0.01 KB (+0.18%)
bundle/brand.ts 6.32 KB 6.30 KB +0.02 KB (+0.35%)
bundle/cache.ts 9.45 KB 9.43 KB +0.01 KB (+0.16%)
bundle/config.ts 16.16 KB 16.09 KB +0.07 KB (+0.44%)
bundle/differ.ts 13.99 KB 13.93 KB +0.06 KB (+0.45%)
bundle/http-client.ts 18.41 KB 18.41 KB +0.00 KB (+0.01%)
bundle/logger.ts 8.59 KB 8.58 KB +0.01 KB (+0.17%)
bundle/metric.ts 8.61 KB 8.61 KB +0.01 KB (+0.09%)
bundle/optic.ts 7.58 KB 7.55 KB +0.04 KB (+0.50%)
bundle/pubsub.ts 12.96 KB 12.94 KB +0.01 KB (+0.11%)
bundle/queue.ts 10.86 KB 10.85 KB +0.00 KB (+0.02%)
bundle/schedule.ts 9.30 KB 9.29 KB +0.01 KB (+0.14%)
bundle/schema-arbitrary.ts 16.08 KB 16.02 KB +0.06 KB (+0.39%)
bundle/schema-equivalence.ts 15.16 KB 15.10 KB +0.06 KB (+0.39%)
bundle/schema-formatter.ts 15.27 KB 15.20 KB +0.06 KB (+0.41%)
bundle/schema-json-schema.ts 16.46 KB 16.40 KB +0.06 KB (+0.35%)
bundle/schema-record-literals-key.ts 13.56 KB 13.51 KB +0.06 KB (+0.44%)
bundle/schema-string-async.ts 11.18 KB 11.15 KB +0.03 KB (+0.22%)
bundle/schema-string-check.ts 9.94 KB 9.92 KB +0.02 KB (+0.23%)
bundle/schema-string.ts 9.51 KB 9.49 KB +0.02 KB (+0.21%)
bundle/schema-stringPojo.ts 15.08 KB 15.01 KB +0.07 KB (+0.43%)
bundle/schema-template-literal.ts 12.18 KB 12.16 KB +0.02 KB (+0.16%)
bundle/schema.ts 14.71 KB 14.64 KB +0.06 KB (+0.44%)
bundle/stm.ts 11.68 KB 11.68 KB +0.01 KB (+0.08%)
bundle/stream.ts 8.27 KB 8.25 KB +0.02 KB (+0.24%)

@github-actions
Copy link

📊 JSDoc Documentation Analysis

📈 Current Analysis Results
Analyzing 63 TypeScript files in packages/effect/src/ (including schema and config subdirectories)...

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

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 63
Total exported members: 2127
Missing @example: 1007 (47.3%)
Missing @category: 342 (16.1%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. schema/Schema.ts
   📝 414 missing examples, 🏷️  234 missing categories
   📦 414 total exports
2. schema/AST.ts
   📝 73 missing examples, 🏷️  13 missing categories
   📦 73 total exports
3. schema/Annotations.ts
   📝 38 missing examples, 🏷️  32 missing categories
   📦 38 total exports
4. schema/Getter.ts
   📝 46 missing examples, 🏷️  3 missing categories
   📦 46 total exports
5. PubSub.ts
   📝 25 missing examples, 🏷️  16 missing categories
   📦 37 total exports
6. schema/Transformation.ts
   📝 25 missing examples, 🏷️  14 missing categories
   📦 25 total exports
7. Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
8. Cause.ts
   📝 28 missing examples, 🏷️  2 missing categories
   📦 69 total exports
9. Effect.ts
   📝 24 missing examples, 🏷️  1 missing categories
   📦 227 total exports
10. SynchronizedRef.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
11. schema/Issue.ts
   📝 22 missing examples, 🏷️  2 missing categories
   📦 22 total exports
12. schema/Parser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
13. ConfigProvider.ts
   📝 21 missing examples, 🏷️  1 missing categories
   📦 21 total exports
14. DateTime.ts
   📝 20 missing examples, 🏷️  0 missing categories
   📦 108 total exports
15. Optic.ts
   📝 18 missing examples, 🏷️  0 missing categories
   📦 18 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Clock.ts (5 exports)
   Console.ts (21 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   Match.ts (57 exports)
   MutableRef.ts (17 exports)
   RcRef.ts (5 exports)
   RegExp.ts (3 exports)
   Runtime.ts (3 exports)
   Schedule.ts (49 exports)
   Symbol.ts (1 exports)
   index.ts (0 exports)
   schema/index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM schema/Schema.ts
-----------------------------------
   Optionality (type, line 53): missing example, category
   Mutability (type, line 60): missing example, category
   ConstructorDefault (type, line 67): missing example, category
   MakeOptions (interface, line 75): missing example, category
   Bottom (interface, line 99): missing example, category
   declareConstructor (interface, line 179): missing example, category
   declareConstructor (function, line 203): missing example
   declare (interface, line 227): missing example
   declare (function, line 236): missing example, category
   revealBottom (function, line 256): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
type: 112 missing examples, 58 missing categories
const: 383 missing examples, 98 missing categories
interface: 189 missing examples, 121 missing categories
class: 54 missing examples, 3 missing categories
function: 241 missing examples, 47 missing categories
namespace: 28 missing examples, 15 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 1120/2127 (52.7% complete)
Categories: 1785/2127 (83.9% complete)

============================================================
Analysis complete! 1349 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.

@gcanti gcanti merged commit e3ea0b5 into Effect-TS:main Nov 14, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants