Skip to content

Commit 2f95504

Browse files
committed
docs: describe @Uncommon convention and AE use in demos
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01E2Njj4j1r9twkVcXsMySLW
1 parent 289b0d1 commit 2f95504

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@
2222
Almost all core extensions can be loaded at once with `require 'facets'`.
2323
Standard and rails extensions should be required by file.
2424

25-
* Some core methods are included on a *trial* basis, and these are not
26-
necessary loaded automatically with `require 'facets'`. These should be
27-
documented as such in the method comments.
25+
* Some core methods are *uncommon* and are not loaded by `require 'facets'`.
26+
Mark them with an `@uncommon` tag in the method comments, showing the
27+
require line, and comment out their line in the aggregator file with
28+
`# uncommon`.
2829

2930
* Standard libraries that are not extensions of existing standard libraries
3031
do not have to be divvied up into individual method files. But note that
@@ -107,8 +108,8 @@ The test suite uses four tools:
107108
`ruby-test` command used by the Rake tasks.
108109
* **Lemon** defines the `test_case`, `method`, and `test` structure of the unit
109110
tests.
110-
* **AE** provides assertions such as `.assert` and `expect` inside those tests.
111-
It is installed as a Lemon dependency.
111+
* **AE** provides assertions such as `.assert` and `expect`, used in both the
112+
unit tests and the QED demos. It is installed as a Lemon dependency.
112113
* **QED** runs the executable examples in `demo/`. They show how a method is
113114
intended to be used as well as checking its behavior.
114115

0 commit comments

Comments
 (0)