Skip to content

Commit fb52ad9

Browse files
author
Gerit Wagner
committed
update docs
1 parent 2b55714 commit fb52ad9

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

docs/source/index.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ We can also parse a query from a string or a `JSON search file <#json-search-fil
6969
query_string = '("digital health"[Title/Abstract]) AND ("privacy"[Title/Abstract])'
7070
query = parse(query_string, syntax="pubmed")
7171
72-
Once we have created a :literal:`query` object, we may want to translate it for different databases.
72+
Once we have created a :literal:`query` object, we can translate it for different databases.
7373
Note how the syntax is translated and how the search for :literal:`Title/Abstract` is spit into two elements:
7474

7575
.. code-block:: python
@@ -159,8 +159,6 @@ To write a query to a JSON file, run the serializer:
159159
date={}
160160
)
161161
162-
163-
164162
CLI Use
165163
=======
166164

@@ -170,7 +168,6 @@ Linters can be run on the CLI:
170168
171169
search-file-lint search-file.json
172170
173-
174171
Pre-commit Hooks
175172
================
176173

@@ -204,24 +201,33 @@ To activate and run:
204201
pre-commit install
205202
pre-commit run --all
206203
207-
208204
Parser development
209205
-------------------------
210206

211207
To develop a parser, see `dev-parser <dev_docs/parser.html>`_ docs.
212208

213-
214209
References
215210
----------------
216211

217212
Haddaway, N. R., Rethlefsen, M. L., Davies, M., Glanville, J., McGowan, B., Nyhan, K., & Young, S. (2022). A suggested data structure for transparent and repeatable reporting of bibliographic searching. *Campbell Systematic Reviews*, 18(4), e1288. doi:`10.1002/cl2.1288 <https://onlinelibrary.wiley.com/doi/full/10.1002/cl2.1288>`_
218213

219-
220214
.. toctree::
221215
:hidden:
222-
:maxdepth: 1
216+
:maxdepth: 2
223217
:caption: Contents:
224218

219+
.. toctree::
220+
:hidden:
221+
:maxdepth: 2
222+
:caption: Manual
223+
225224
parser/parser_index
226225
messages/errors_index
226+
api_search/api_search
227+
228+
.. toctree::
229+
:hidden:
230+
:caption: Developer documentation
231+
:maxdepth: 1
232+
227233
dev_docs/parser

docs/source/messages/errors_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _query-error-messages:
22

3-
Messages
3+
Linter messages
44
====================
55

66
Overview of query error messages grouped by type.

0 commit comments

Comments
 (0)