Skip to content

Commit

Permalink
Revert "Autodoc commit"
Browse files Browse the repository at this point in the history
This reverts commit 1b496b2.
  • Loading branch information
puredanger committed Apr 10, 2019
1 parent 1b496b2 commit 0a96d22
Show file tree
Hide file tree
Showing 17 changed files with 4,201 additions and 0 deletions.
58 changes: 58 additions & 0 deletions CHANGES.md
@@ -0,0 +1,58 @@
# Change Log for spec-alpha2

## FORKED from spec.alpha on Oct 22, 2018

## Version 0.2.176 on Sept 4, 2018

* [CLJ-2373](https://dev.clojure.org/jira/browse/CLJ-2373) Don't print ex-info into spec errors
* [CLJ-2391](https://dev.clojure.org/jira/browse/CLJ-2391) Change spec problem line print order
* [CLJ-2392](https://dev.clojure.org/jira/browse/CLJ-2392) Stop prepending :args to spec problem paths
* [CLJ-2393](https://dev.clojure.org/jira/browse/CLJ-2393) Sort on descending "in" length before "at" length

## Version 0.2.168 on June 26, 2018

* [CLJ-2182](https://dev.clojure.org/jira/browse/CLJ-2182) Always check preds for s/& on nil input
* [CLJ-2178](https://dev.clojure.org/jira/browse/CLJ-2178) Return resolved pred for s/& explain-data
* [CLJ-2177](https://dev.clojure.org/jira/browse/CLJ-2177) Return valid resolved pred in s/keys explain-data
* [CLJ-2167](https://dev.clojure.org/jira/browse/CLJ-2176) Properly check for int? in int-in-range?
* [CLJ-2166](https://dev.clojure.org/jira/browse/CLJ-2166) added function name to instrument exception map
* [CLJ-2111](https://dev.clojure.org/jira/browse/CLJ-2111) Clarify docstring for :kind in s/every
* [CLJ-2068](https://dev.clojure.org/jira/browse/CLJ-2068) Capture form of set and function instances in spec
* [CLJ-2060](https://dev.clojure.org/jira/browse/CLJ-2060) Remove a spec by s/def of nil
* [CLJ-2046](https://dev.clojure.org/jira/browse/CLJ-2046) gen random subsets of or'd req keys in map specs
* [CLJ-2026](https://dev.clojure.org/jira/browse/CLJ-2026) Prevent concurrent loads in dynaload
* [CLJ-2176](https://dev.clojure.org/jira/browse/CLJ-2176) s/tuple explain-data :pred problem

## Version 0.1.143 on Oct 30, 2017

* [CLJ-2259](https://dev.clojure.org/jira/browse/CLJ-2259) - map decimal? to big decimal generator (instead of bigdec?)

## Version 0.1.134 on Oct 6, 2017

* [CLJ-2103](https://dev.clojure.org/jira/browse/CLJ-2103) - s/coll-of and s/every gen is very slow if :kind specified without :into
* [CLJ-2171](https://dev.clojure.org/jira/browse/CLJ-2171) - Default explain printer shouldn't print root val and spec
* Mark Clojure dependency as a provided dep so it's not transitively included

## Version 0.1.123 on May 26, 2017

* No changes, just a rebuild

## Version 0.1.109 on May 26, 2017

* [CLJ-2153](https://dev.clojure.org/jira/browse/CLJ-2153) - Docstring for int-in-range? and int-in now mention fixed precision constraint
* [CLJ-2085](https://dev.clojure.org/jira/browse/CLJ-2085) - Add the top level spec and value to explain-data
* [CLJ-2076](https://dev.clojure.org/jira/browse/CLJ-2076) - coll-of and map-of should unform their elements
* [CLJ-2063](https://dev.clojure.org/jira/browse/CLJ-2063) - report explain errors in order from longest to shortest path
* [CLJ-2061](https://dev.clojure.org/jira/browse/CLJ-2061) - Better error message when exercise-fn called on fn without :args spec
* [CLJ-2059](https://dev.clojure.org/jira/browse/CLJ-2059) - explain-data should return resolved preds
* [CLJ-2057](https://dev.clojure.org/jira/browse/CLJ-2057) - If :ret spec is not supplied, use any?

## Version 0.1.108 on May 2, 2017

* AOT compile the spec namespaces

## Version 0.1.94 on Apr 26, 2017

* Moved spec namespaces from Clojure
* Renamed spec namespaces to append ".alpha"

14 changes: 14 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,14 @@
This is a [Clojure contrib] project.

Under the Clojure contrib [guidelines], this project cannot accept
pull requests. All patches must be submitted via [JIRA].

See [Contributing] and the [FAQ] on the Clojure development [wiki] for
more information on how to contribute.

[Clojure contrib]: http://dev.clojure.org/display/doc/Clojure+Contrib
[Contributing]: http://dev.clojure.org/display/community/Contributing
[FAQ]: http://dev.clojure.org/display/community/Contributing+FAQ
[JIRA]: http://dev.clojure.org/jira/browse/CCACHE
[guidelines]: http://dev.clojure.org/display/community/Guidelines+for+Clojure+Contrib+committers
[wiki]: http://dev.clojure.org/
73 changes: 73 additions & 0 deletions README.md
@@ -0,0 +1,73 @@
spec-alpha2
========================================

spec is a Clojure library to describe the structure of data and functions. Specs can be used to validate data, conform (destructure) data, explain invalid data, generate examples that conform to the specs, and automatically use generative testing to test functions.

For more information:

* Rationale - https://clojure.org/about/spec
* Guide - https://clojure.org/guides/spec (for spec.alpha, note namespaces and other differences below)

spec.alpha was released with Clojure 1.9 and can be found at https://github.com/clojure/spec.alpha. spec-alpha2 incorporates feedback from spec.alpha as well as work towards several new features. Please note that spec-alpha2 is not 100% API-compatible with spec.alpha (although it is similar).

Namespaces to load:

(require '[clojure.spec-alpha2 :as s]
'[clojure.spec-alpha2.gen :as gen]
'[clojure.spec-alpha2.test :as test])

Also see: [Differences from spec.alpha](https://github.com/clojure/spec-alpha2/wiki/Differences-from-spec.alpha)


Releases and Dependency Information
========================================

Development release:

During development, you can use the git dep to try spec-alpha2:

clj -Sdeps '{:deps {org.clojure/clojure {:mvn/version "1.10.0"}
org.clojure/test.check {:mvn/version "0.9.0"}
org.clojure/spec-alpha2 {:git/url "https://github.com/clojure/spec-alpha2.git"
:sha "<SHA>"}}}'

Where the latest SHA can be found with:

git ls-remote https://github.com/clojure/spec-alpha2.git refs/heads/master


Latest stable release: TBD

* [All Released Versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22spec-alpha2%22)
* [Development Snapshot Versions](https://oss.sonatype.org/index.html#nexus-search;gav~org.clojure~spec-alpha2~~~)

[deps.edn](https://clojure.org/guides/deps_and_cli) dependency information:

org.clojure/spec-alpha2 {:mvn/version "TBD"}

[Leiningen](https://github.com/technomancy/leiningen) dependency information:

[org.clojure/spec-alpha2 "TBD"]

[Maven](http://maven.apache.org/) dependency information:

<dependency>
<groupId>org.clojure</groupId>
<artifactId>spec-alpha2</artifactId>
<version>TBD</version>
</dependency>

Developer Information
========================================

* [API docs](http://clojure.github.io/spec-alpha2/)
* [GitHub project](https://github.com/clojure/spec-alpha2)
* [Changelog](https://github.com/clojure/spec-alpha2/blob/master/CHANGES.md)
* [Bug Tracker](http://dev.clojure.org/jira/browse/CLJ)
* [Continuous Integration](http://build.clojure.org/job/spec-alpha2/)
* [Compatibility Test Matrix](http://build.clojure.org/job/spec-alpha2-test-matrix/)

Copyright and License
========================================

Copyright (c) Rich Hickey, and contributors, 2018. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound bythe terms of this license. You must not remove this notice, or any other, from this software.
1 change: 1 addition & 0 deletions VERSION_TEMPLATE
@@ -0,0 +1 @@
0.2.GENERATED_VERSION

0 comments on commit 0a96d22

Please sign in to comment.