Cleaning up documentation

xo · Aug 14, 2019 · 60dd1ad · 60dd1ad
1 parent 289c5ea
commit 60dd1ad
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -188,7 +188,7 @@ to be imported:
 | Snowflake (snowflake)        | [github.com/snowflakedb/gosnowflake](https://github.com/snowflakedb/gosnowflake)            |
 | VoltDB (voltdb)              | [github.com/VoltDB/voltdb-client-go/voltdbclient](github.com/VoltDB/voltdb-client-go])      |
 
-Please see [the `dburl` GoDoc listing][godoc-dburl] for the full API
+Please see [the `dburl` GoDoc listing][godoc-link] for the full API
 documentation.
 
 ### URL Parsing Rules

diff --git a/dburl.go b/dburl.go
@@ -150,14 +150,13 @@
 //   Snowflake (snowflake)        | github.com/snowflakedb/gosnowflake
 //   VoltDB (voltdb)              | github.com/VoltDB/voltdb-client-go/voltdbclient
 //
-// * OLE ODBC is not an actual protocol, but instead is an alias for using the
-//   "MSDASQL.1" OLE provider with the ADODB driver, and the DSN will be an
-//   ADODB DSN, but with "Extended Properties" for the respective ODBC
-//   parameters, including the underlying transport prootocol. As such,
-//   "oleodbc+protocol://user:pass@host/dbname" URLs are equivalent to
-//   "adodb://MSDASQL.1/?Extended+Properties=...". Please see the
-//   documentation for GenOLEODBC for information regarding how URL components
-//   are mapped/passed to ADODB's Extended Properties parameter.
+// * OLE ODBC is a special alias for using the "MSDASQL.1" OLE provider with the
+// ADODB driver on Windows. oleodbc:// URLs will be converted to the equivalent
+// ADODB DSN with "Extended Properties" having the respective ODBC parameters,
+// including the underlying transport prootocol. As such, oleodbc+protocol://user:pass@host/dbname
+// URLs are equivalent to adodb://MSDASQL.1/?Extended+Properties=.... on
+// Windows. See GenOLEODBC for information regarding how URL components are
+// mapped and passed to ADODB's Extended Properties parameter.
 //
 // URL Parsing Rules
 //