From f4eefbaeac8f3d5418a544471bb837cf52d4304c Mon Sep 17 00:00:00 2001 From: Sean Corfield Date: Sun, 21 Apr 2019 18:08:09 -0700 Subject: [PATCH] Final doc cleanup prior to initial public announcement --- CHANGELOG.md | 4 ++-- CONTRIBUTING.md | 6 +++--- README.md | 2 +- doc/all-the-options.md | 2 +- doc/friendly-sql-functions.md | 2 +- doc/prepared-statements.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e5d2d1..536cf09 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ -# Hammock Space +# Change Log -This project is still in "hammock" mode and hasn't come close to even a preliminary pre-alpha release. +2019-04-21 -- 1.0.0-alpha7 -- Initial publicly announced release. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1008bc4..067e751 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ # next.jdbc The next generation of [`clojure.java.jdbc`](https://github.com/clojure/java.jdbc) -is *not yet accepting contributions* because it I do -not know yet whether it will become a Contrib project (like `clojure.java.jdbc`) +is *still not accepting contributions* because it I have not yet decided +whether it will become a Contrib project (like `clojure.java.jdbc`) or whether it will continue to be a public, open source project. Please do not send Pull Requests at this point! Feel free to [open Issues](https://github.com/seancorfield/next-jdbc/issues) with opinions -and suggestions -- I'm happy to have discussions about the concepts! +and suggestions -- I'm happy to have discussions about any aspect of the library! diff --git a/README.md b/README.md index f5a2331..fb7a00c 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ In addition, convenience functions -- "syntactic sugar" -- are provided to inser * [Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started) * [Friendly SQL Functions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/friendly-sql-functions) -* [Row and Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) +* [Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) * [Prepared Statements](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-statements) * [Transactions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions) * [All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/all-the-options) diff --git a/doc/all-the-options.md b/doc/all-the-options.md index efa0bea..e4cc06a 100644 --- a/doc/all-the-options.md +++ b/doc/all-the-options.md @@ -60,4 +60,4 @@ The `transact` function and `with-transaction` macro accept the following option * `:read-only` -- a `Boolean` that indicates whether the transaction should be read-only or not (the default), * `:rollback-only` -- a `Boolean` that indicates whether the transaction should commit on success (the default) or rollback. -[<: Transaction](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions) | [Migration from `clojure.java.jdbc` :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/migration-from-clojure-java-jdbc) +[<: Transactions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions) | [Migration from `clojure.java.jdbc` :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/migration-from-clojure-java-jdbc) diff --git a/doc/friendly-sql-functions.md b/doc/friendly-sql-functions.md index 9f5a029..5e2fa25 100644 --- a/doc/friendly-sql-functions.md +++ b/doc/friendly-sql-functions.md @@ -152,4 +152,4 @@ These quoting functions can be provided to any of the friendly SQL functions abo Note that the entity naming function is passed a string, the result of calling `name` on the keyword passed in. Also note that the default quoting functions do not handle schema-qualified names, such as `dbo.table_name` -- `sql-server` would produce `[dbo.table_name]` from that. Use the `schema` function to wrap the quoting function if you need that behavior, e.g,. `{:table-fn (schema sql-server)}` which would produce `[dbo].[table_name]`. -[<: Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started) | [Row and Result Set Builders :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) +[<: Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started) | [Result Set Builders :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) diff --git a/doc/prepared-statements.md b/doc/prepared-statements.md index b3af98a..aa801c0 100644 --- a/doc/prepared-statements.md +++ b/doc/prepared-statements.md @@ -30,4 +30,4 @@ This can be extended to any Clojure data type, to provide a customized way to ad If you need more specialized parameter handling than the protocol can provide, then you can create prepared statements explicitly, instead of letting `next.jdbc` do it for you, and then calling your own variant of `set-parameters` to install those parameters. -[<: Row and Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) | [Transactions :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions) +[<: Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) | [Transactions :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions)