Skip to content

Commit 03d8ade

Browse files
committed
Changes headers from title case to sentence case
1 parent 52fa321 commit 03d8ade

File tree

7 files changed

+37
-37
lines changed

7 files changed

+37
-37
lines changed

docs/appendices/compatibility.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Compatibility
1111

1212
.. _versions:
1313

14-
Version Notes
14+
Version notes
1515
=============
1616

1717
.. _python-versions:
@@ -113,7 +113,7 @@ Consult the following table for CrateDB version compatibility notes:
113113

114114
.. _implementations:
115115

116-
Implementation Notes
116+
Implementation notes
117117
====================
118118

119119
.. _sqlalchemy-implementation:
@@ -123,7 +123,7 @@ SQLAlchemy
123123

124124
.. _sqlalchemy-features:
125125

126-
Supported Features
126+
Supported features
127127
..................
128128

129129
Currently, CrateDB only implements a subset of the SQL standard. Additionally,
@@ -173,7 +173,7 @@ Consult the following table for specifics:
173173

174174
.. _sqlalchemy-version-notes:
175175

176-
Version Notes
176+
Version notes
177177
.............
178178

179179
+----------------+-----------------+-------------------------------------------+
@@ -196,7 +196,7 @@ Version Notes
196196

197197
.. _earlier-versions:
198198

199-
Older Versions
199+
Older versions
200200
==============
201201

202202
For information about older versions of the client, consult `the 0.14.2

docs/appendices/data-types.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ section for further information.
1515

1616
.. _data-types-db-api:
1717

18-
Database API Client
18+
Database API client
1919
===================
2020

2121
This section documents data types for the CrateDB :ref:`Database API client
@@ -107,7 +107,7 @@ This section documents data types for the CrateDB :ref:`SQLAlchemy dialect
107107

108108
.. _sqlalchemy-type-map:
109109

110-
Type Map
110+
Type map
111111
--------
112112

113113
The CrateDB dialect maps between data types like so:

docs/blobs.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ storage capabilities`_ of your CrateDB cluster.
1212
.. contents::
1313
:local:
1414

15-
Get a Blob Container
15+
Get a blob container
1616
====================
1717

1818
The first thing you will need to do is connect to CrateDB. Follow the
@@ -41,10 +41,10 @@ Here, we have created a ``BlobContainer`` for the ``my_blobs`` table, using
4141

4242
Now we can start working with our blob container.
4343

44-
Working With the Blob Container
44+
Working with the blob container
4545
===============================
4646

47-
Upload Blobs
47+
Upload blobs
4848
------------
4949

5050
The blob container can work with files or *file-like objects*, as long as
@@ -104,7 +104,7 @@ And upload it:
104104
The ``put`` method returns ``True``, indicating that the object has been
105105
written to the blob container.
106106

107-
Retrieve Blobs
107+
Retrieve blobs
108108
--------------
109109

110110
To retrieve a blob, you need to know its digest.
@@ -140,7 +140,7 @@ generator is like so:
140140
... blob_content += chunk
141141

142142

143-
Delete Blobs
143+
Delete blobs
144144
------------
145145

146146
You can delete a blob with the ``delete`` method and the blob digest, like so::

docs/connect.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Connect to CrateDB
2626

2727
.. _single-node:
2828

29-
Connect to a Single Node
29+
Connect to a single node
3030
========================
3131

3232
To connect to a single CrateDB node, use the ``connect()`` function, like so:
@@ -65,7 +65,7 @@ for HTTP requests on port 4200, the node URL would be
6565

6666
.. _multiple-nodes:
6767

68-
Connect to Multiple Nodes
68+
Connect to multiple nodes
6969
=========================
7070

7171
To connect to one of multiple nodes, pass a list of database URLs to the
@@ -89,7 +89,7 @@ You can pass in as many node URLs as you like.
8989

9090
.. _connection-options:
9191

92-
Connection Options
92+
Connection options
9393
==================
9494

9595
HTTPS
@@ -109,7 +109,7 @@ URL:
109109
The CrateDB reference has a section on `setting up SSL`_. This will be
110110
useful background reading for the following two subsections.
111111

112-
Server Verification
112+
Server verification
113113
...................
114114

115115
You can enable server SSL certificate verification by passing in the
@@ -126,7 +126,7 @@ Here's how you might do that::
126126
Here, replace ``<CA_CERT_FILE>`` with the path to the CA certificate file.
127127

128128

129-
Client Verification
129+
Client verification
130130
...................
131131

132132
The client also supports client verification via client certificates.
@@ -196,7 +196,7 @@ and password.
196196

197197
.. _schema-selection:
198198

199-
Schema Selection
199+
Schema selection
200200
================
201201

202202
You can select a schema using the optional ``schema`` argument, like so:
@@ -213,7 +213,7 @@ with the rest of your arguments.
213213

214214
However, you can query any schema you like by specifying it in the query.
215215

216-
Next Steps
216+
Next steps
217217
==========
218218

219219
Once you're connected, you can :ref:`query CrateDB <query>`.

docs/getting-started.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ After that is done, you can import the library, like so:
3636

3737
>>> from crate import client
3838

39-
Interactive Use
39+
Interactive use
4040
===============
4141

4242
Python provides a REPL_, also known as an interactive language shell. It's a
@@ -57,13 +57,13 @@ object), iPython's autocompletion, and many other features.
5757

5858
`The iPython Documentation`_
5959

60-
Set Up as a Dependency
60+
Set up as a dependency
6161
======================
6262

6363
There are `many ways`_ to handle Python project dependencies. The official PyPI
6464
package should be compatible with all of them.
6565

66-
Next Steps
66+
Next steps
6767
==========
6868

6969
Learn how to :ref:`connect to CrateDB <connect>`.

docs/query.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Query CrateDB
2424
.. contents::
2525
:local:
2626

27-
Using a Cursor
27+
Using a cursor
2828
==============
2929

3030
After :ref:`connecting to CrateDB <connect>`, you can execute queries via a
@@ -36,10 +36,10 @@ Open a cursor like so::
3636

3737
.. _inserts:
3838

39-
Inserting Data
39+
Inserting data
4040
==============
4141

42-
Regular Inserts
42+
Regular inserts
4343
---------------
4444

4545
Regular inserts are possible with the ``execute()`` method, like so:
@@ -60,7 +60,7 @@ in the order they appear.
6060
Always use the string interpolation feature of the client library (per the
6161
above example) to guard against malicious input.
6262

63-
Bulk Inserts
63+
Bulk inserts
6464
------------
6565

6666
`Bulk inserts`_ are possible with the ``executemany()`` method, which takes a
@@ -80,10 +80,10 @@ dictionary may additionally have an ``error_message`` key.
8080

8181
.. _selects:
8282

83-
Selecting Data
83+
Selecting data
8484
==============
8585

86-
Executing a Query
86+
Executing a query
8787
-----------------
8888

8989
Selects can be performed with the ``execute()`` method, like so::
@@ -101,7 +101,7 @@ argument) where the ``?`` character appears.
101101
After executing a query, you can fetch the results using one of three fetch
102102
methods, detailed below.
103103

104-
Fetching Results
104+
Fetching results
105105
----------------
106106

107107
``fetchone()``
@@ -154,7 +154,7 @@ remaining rows::
154154
['Old Faithful'],
155155
['Outer Eastern Rim']]
156156

157-
Accessing Column Names
157+
Accessing column names
158158
======================
159159

160160
Result rows are lists, not dictionaries. Which means that they do use contain

docs/sqlalchemy.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ Example host strings:
7171
If ``<HOST>`` is blank (i.e. just ``crate://``) then ``localhost:4200`` will
7272
be assumed.
7373

74-
Getting a Connection
74+
Getting a connection
7575
--------------------
7676

77-
Create an Engine
77+
Create an engine
7878
................
7979

8080

@@ -121,7 +121,7 @@ too::
121121
Here, ``<PATH_TO_CA_CERT>`` should be replaced with the path to the correct CA
122122
certificate.
123123

124-
Get a Session
124+
Get a session
125125
.............
126126

127127
Once you have an CrateDB ``engine`` set up, you can create and use an SQLAlchemy
@@ -145,7 +145,7 @@ Tables
145145

146146
.. _table-definition:
147147

148-
Table Definition
148+
Table definition
149149
----------------
150150

151151
Here is an example SQLAlchemy table definition using the `declarative
@@ -200,7 +200,7 @@ In this example, we:
200200

201201
.. _using-extension-types:
202202

203-
Extension Types
203+
Extension types
204204
---------------
205205

206206
In the :ref:`example SQLAlchemy table definition <table-definition>` above, we
@@ -349,7 +349,7 @@ for all matching rows::
349349

350350
.. _aggregate-functions:
351351

352-
Aggregate Functions
352+
Aggregate functions
353353
-------------------
354354

355355
SQLAlchemy supports different ways to `count result rows`_. However, because
@@ -382,7 +382,7 @@ these methods, like so:
382382
... .order_by(Character.name).all()
383383
[(1, u'Arthur Dent'), (1, u'Tricia McMillan')]
384384

385-
Fulltext Search
385+
Fulltext search
386386
---------------
387387

388388
Matching

0 commit comments

Comments
 (0)