Write documentation. #97
Comments
bigeasy
pushed a commit
that referenced
this issue
Oct 17, 2020
bigeasy
pushed a commit
that referenced
this issue
Oct 19, 2020
Unhappy with the quality of the examples. Would like them to be more realistic. Added some thoughts to the diary as well. See #97.
bigeasy
pushed a commit
that referenced
this issue
Oct 19, 2020
bigeasy
pushed a commit
that referenced
this issue
Oct 19, 2020
* Fix `callee` argument. Closes #106. * Diary about formatted messages. See #97. * Remove `properties` argument. Closes #105. * Upgrade `keyify` to `2.0.5`. Closes #104. * Scratch out some more Docco. See #97. * Rename your Docco readme. * Use whitespace/non-whitespace character class. See #102. * Add `messages` property to generated class. Closes #103. * Notes on parsing stack traces. See #102. * There will be no prefixes appended to codes. See #96. * Notes on what happens when a stack is a biggun. * Implement prune of repeated causes. Closes #101. * Build with only Node.js 12 on GitHub Actions. Closes #100. * Build with only Node.js 12 on Travis CI. Closes #99. * Export `Iterator` class. Closes #98. * Swipe at some Docco based documentation. See See #97. * Implement error code to message format map. Closes #96. * Implement formatted error messages. Closes #95. Closes #107.
bigeasy
pushed a commit
that referenced
this issue
Nov 23, 2020
bigeasy
pushed a commit
that referenced
this issue
Nov 23, 2020
When I want to catch exceptions by type I use `rescue` which is neither Interrupt nor Node.js specific. See #97.
bigeasy
pushed a commit
that referenced
this issue
Nov 24, 2020
After the tagline decision, things ought to be a little easier. See #97.
bigeasy
pushed a commit
that referenced
this issue
Nov 25, 2020
bigeasy
pushed a commit
that referenced
this issue
Nov 25, 2020
Documenting `assert` for the sake of getting the deferred construction right. There is an ambiguity with deferred construct in that it is always just a function but callee is also a function. I'm creating many special cases in the code trying to not interpret it as a callee. I want to provided memoized resolvers, callbackers, etc. While implementing one I made the `callee` an option and realized that it is a rather uncommon option and could therefore always be an option. This would be easier to document. There is no way to specify a callee as a positional parameter, you must use an option object. Did get an initial `audit` wrapper. Decided that it is enough to just call an audit function since this is only ever intended for use in unit testing, ever for use in production, never to test the exceptions of a dependency. If those use cases arise you can use the audit facility, but it should not be as simple as an environment variable, as if it was a dormant production facility that ready to be switched on and off. Going to update the documentation first, to see if it makes life easier, then continue with the implementation of the wrapper functions. See #117. See #114. See #97.
bigeasy
pushed a commit
that referenced
this issue
Nov 26, 2020
Ambiguity when merging options objects. The object to merge, is it an options array or a context (properties) object? So, we won't be merging them. You can merge using JavaScript destructuring notation. See #97.
bigeasy
pushed a commit
that referenced
this issue
Nov 27, 2020
bigeasy
pushed a commit
that referenced
this issue
Nov 30, 2020
Going to get the coverage using `readme.t.js`. Going to use the coverage to drive documentation. See #97.
bigeasy
pushed a commit
that referenced
this issue
Nov 30, 2020
Pulled all the static function protected functions out of the class and into the declaring scope. Need to come up with a naming convention since the namespace is now cluttered. Added some Docco to `interrupt.js`. Deleted dead code. See #97.
bigeasy
pushed a commit
that referenced
this issue
Nov 30, 2020
bigeasy
pushed a commit
that referenced
this issue
Nov 30, 2020
The `options.code` will always be a string. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 2, 2020
I generally try to leave a commit message about what was done but writing to tell you what I wrote in the writing I just wrote is drudgery. Please just have a look at the diffs. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 2, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 2, 2020
Going to ask you to look at the diffs rather than repeat the diary entry here. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 2, 2020
Warn against using variable properties on exceptions that really ought to be available in the scope of the catch block. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 4, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 5, 2020
That's what its there for. Added a description of `swipe.t.js` to its introduction. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 8, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 8, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 8, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 8, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 9, 2020
Covered the static functions of `Interrupt` with an entry. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 9, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 9, 2020
* Delete unused swipe. See #97. * Remove `Context` class. Closes #144. * Documentation and test for `sprintf` errors. See #95. See #97. * Documentation on inheritance in `swipe.t.js`. See #97. See #133. * Clean up `README.md`. See #97. * Remove debugging message. * An integer argument sets stack trace limit. See #97. See #143. * Implement `toString()` and `inspect.util`. Closes #142. * Inheritance and aliases. * Import symbols using `symbol`. See #133. * Move existing inheritance into `swipe.t.js`. See #133. * Sorted out construction of aliases. See #140. * Rename `Merge.argument` to `combine`. See #140. See #97. * Move used verbiage to `swipe.t.js`. See #97. * Tidy newline printing in `readme.t.js`. See #97. * `codes` no longer reports templates. See #133. See #140. * Tidy declaration of codes lookup. See #133. See #140. * Options object can now go anywhere. See #117. * Sketch of plain code inheritance. See #133. See #141. * Non-enumerable properties in defaults. See #141. * Non-enumerable properties in constructor. See #141. * Corral class properties into `Prototype`. See #133. See #140. * `create` unshifts onto `vargs`. See #133. See #140. * Added thoughts about inheritance to docs. See #133. See #140. * Inheriting templates from super class. See #140. * Sketch of aliases. See #140. * Implement sprintf-only properties. Closes #127. * Document the appropriate use of error properties. See #97. * Derive from derived super class, inherit codes. Closes #133. * Moving some documentation around, diary entry. See #97. * Talk default properties and codes before JSON. See #97. * More documentation. See #97. * Convert nested Errors to Interrupt format. See #102. * Re-implementation of stack trace parser. See #102. * Sort out enumerability. Closes #128. * Thoughts on printing non-Error nested errors. * `code` returns an object. Closes #139. * Print not code if null, nor context if empty. Closes #137. * Reorganization, deliminate some dead code. See #97. * Additional documentation. See #97. * Create static function to get the error message. See #97. Closes #136. * Documentation and reorgainzation. See #97. * Remove old `interrupt.t.js` unit test. See #97. * Remove `assert`. See #131. * Actually using the circular reference JSON. See #130. * `Interrupt.Error` error codes for meta-errors. Closes #131. * Will not derive from `AggregateError`. Closes #116. * Implement a forgiving JSON serializer. Closes #130. * Use `Instances` instead of `MATERIAL`. * Created a context object for nested error context. Closes #135. * Display code in stack trace. * Add test temp directory to `.gitignore`. * Implement default properties by code. Closes #134. * Fix options merging. See #117. * Sketch of code inerhitence. See #133. * Sketch of audit, `sprintf` errors reported. See #114. Closes #122. * One rename of `properties` was skipped. See #129. * Reordered assistants in order of documentation. See #97. * Rename `context` to `properties`. Closes #129. * Currying appears to be finished. Closes #125. * Use the finalized deferred constructor. See #125. See #113. See #112. See #111. * Implement sync `try`/`catch` wapper. See #113. * Decide on `callback()` function signature. See #112. * Sketch of currying, implement `voptions`. See #125. See #111. Closes #126. * Settle on an argument order for constructor. See #117. Seem to have removed ambiguities. The first argument to the constructor * Documentation, discovered an ambiguity. See #97. * Sketch auditing, deferred construct. Assert docs. See #97. See #114. See #117. * Create `Symbol`s for error codes. Closes #124. * Fix `sprintf` format selection. See #117. * Fix `readme.t.js` example error formats. See #97. * Catch `sprintf` errors. See #117. See #122. * Assert that `Interrupt` is protected. Closes #123. * Rename `causes` to `errors. Closes #115. * Further sketch of named parameters. See #117. * Build with Node.js 15 on Travis CI. Closes #121. * Remove dead code. * Build with Node.js 15 on GitHub Actions. Closes #120. * Build with Node.js 14 on GitHub Actions. Closes #119. * Build with Node.js 14 at Travis CI. Closes #118. * Start named parameters, no constructor assertions. See #117. Closes #110. * Promise resolver, callback helper function. * Poking at the `readme.t.js`. See #97. * Change tagline. See #97. * Add a TODO. See #110. * Make `readme.t.js` a unit test. See #97. Closes #145.
bigeasy
pushed a commit
that referenced
this issue
Dec 10, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 10, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 10, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 11, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 11, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 11, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 11, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 11, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 11, 2020
Broke it while writing the second draft. Added some assertions to illustrate code name to symbol properties on the generated error class. See #97.
bigeasy
pushed a commit
that referenced
this issue
Dec 13, 2020
bigeasy
pushed a commit
that referenced
this issue
Dec 14, 2020
* Tracer resolution in constructor. * Rename `$poker` to `$trace`. * Implement multi-line messages. * Add scanning to stack trace parser. Closes #102. * Split out pokers into a separate section. * Fix callee now that deferred construction is gone. * Fix unit test broken by `$errors` rename. * Added unit test for constructor error parse. * Serialize and parse constructor errors. * Thoughts on preserving deferred construction. * Add `message` to `properties`, properties Docco. See #97. Closes #155.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
No description provided.
The text was updated successfully, but these errors were encountered: