-
Notifications
You must be signed in to change notification settings - Fork 53
Use a "special values" header before the list of special values for elementwise functions #52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…lementwise functions This will make these easier to parse from the test suite, barring something like #49.
I will also push up changes here if I find any of these special values to have inconsistent formatting that prevents them from being parsed. |
Question:
The other functions that have the "implementation-dependent approximation" rules do not have "(rounded)". Does that mean something different here, or should we change it to be consistent (and if so, should they all say "(rounded)" or should it be removed here)? |
I pushed some wording inconsistency fixes. With this branch, |
Re: |
Re: editorial changes. Most of the changes in this PR are fine. I think my main comment is that I'd caution against relying on, e.g., regular expressions to extract special values and auto-populate test data. This approach is bound to be brittle and requires that spec authors have an accurate mental model when writing specs of how test values are generated. This is likely to prove problematic. This is also problematic from the standpoint of duplication. Suppose we want the spec to state that the special values for Personally, while I recognize the desire to ensure that the specs and tests remain in sync, my sense is that, while perhaps more tedious, the tests should simply include explicit lists of test values and expected results (i.e., no "magic") for each mathematical function having spec'd edge cases. If, and when, a particular function's list of special values and/or behavior changes, then part of the responsibility of editors is to ensure that the two (the spec and tests) remain in sync (i.e., the process is manual). My sense is that without rigidly codified rules and an extremely well-defined set of rules governing how sentences are organized and constructed, we're likely to encounter issues ensuring that merged spec changes are guaranteed to be reflected in tests. |
We discussed this in person today. The cautions about brittleness are valid and understood. That said, these language consistency fixes are nice, and we can deal with moving the data for special values of the spec to a more maintainable machine-readable format at a later stage. So let's merge this now. |
This will make these easier to parse from the test suite, barring something
like #49.