Skip to content

Commit b3042ab

Browse files
committed
docs: use sentence case for headings
1 parent d7a5a29 commit b3042ab

18 files changed

+58
-58
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Change Log
2+
# Changelog
33
All notable changes to this project will be documented in this file.
44

55
## Unreleased

docs/source/dev_docs/linter_development.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ They analyze token sequences, syntax, search fields, and operator use to identif
66
errors or ambiguities and print meaningful messages (documented in the `messages <../messages/errors_index.html>`_ section).
77
Each platform implements its own linter, which interhits from the base class `linter_base.py`. Linters are used in the parser methods.
88

9-
Base Classes
9+
Base classes
1010
------------
1111
Use the appropriate base class when developing a new linter:
1212

@@ -16,7 +16,7 @@ Use the appropriate base class when developing a new linter:
1616
Each linter must override the `validate_tokens()` method and the `validate_query_tree()`.
1717
`validate_tokens()` is called when the query is parsed, and `validate_query_tree()` is called when the query tree is built (i.e., at the end of the parsing process **and** when the query is constructed programmatically).
1818

19-
Best Practices
19+
Best practices
2020
--------------
2121
- **Use standardized linter messages** defined in `constants.QueryErrorCode`.
2222
- **Add details** in messages for guidance (e.g., invalid format, missing logic).

docs/source/dev_docs/parser_development.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ When introducing a new parser version, copy the previous versioned
1818
directory, adjust the implementation, and register the version in the
1919
``PARSERS`` dictionary.
2020

21-
1. Inherit from Base Classes
21+
1. Inherit from base classes
2222
-----------------------------------
2323

2424
Use the provided base classes, which provide a number of utility methods:
@@ -107,8 +107,8 @@ Check whether ``SearchFields`` can be created for nested queries (e.g., ``TI=(eH
107107
:language: python
108108

109109

110-
List Format Support
111-
-----------------------------------
110+
List format support
111+
----------------------------------
112112

113113
Implement ``QueryListParser`` to handle numbered sub-queries and references like ``#1 AND #2``.
114114

docs/source/dev_docs/tests.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To run all tests:
1010

1111
pytest test
1212

13-
Test Types
13+
Test types
1414
----------
1515

1616
1. **Tokenization Tests**

docs/source/dev_docs/translator_development.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Translators convert between:
88

99
Each translator implements `QueryTranslator`, the abstract base class from ``translator_base.py``.
1010

11-
Translator Responsibilities
12-
---------------------------
11+
Translator responsibilities
12+
--------------------------
1313

1414
A translator must implement the following two class methods:
1515

@@ -35,8 +35,8 @@ specified platform.
3535
To introduce a new translator version, duplicate the previous versioned directory,
3636
update the implementation as needed, and register the new version in the ``TRANSLATORS`` dictionary.
3737

38-
Utility Methods Provided
39-
------------------------
38+
Utility methods provided
39+
-----------------------
4040

4141
The base class (`QueryTranslator`) provides the following utilities:
4242

@@ -47,8 +47,8 @@ The base class (`QueryTranslator`) provides the following utilities:
4747
- ``move_fields_to_operator(query)``:
4848
If all children have the same field, moves it to the parent node.
4949

50-
Search Field Mapping
51-
--------------------
50+
Search field mapping
51+
-------------------
5252

5353
Field mapping is expected to be defined in a `constants_<source>.py` file and typically includes:
5454

@@ -61,15 +61,15 @@ Each translator should:
6161
2. Handle combined fields (e.g., `[tiab]` in PubMed)
6262
3. Optionally restructure the query for consistency
6363

64-
Code Skeleton
65-
-------------
64+
Code skeleton
65+
------------
6666

6767
.. literalinclude:: translator_skeleton.py
6868
:language: python
6969

7070

71-
Advanced Features
72-
-----------------
71+
Advanced features
72+
----------------
7373

7474
Some translators include advanced restructuring logic:
7575

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ A Jupyter Notebook demo (hosted on Binder) is available here:
113113
.. image:: https://mybinder.org/badge_logo.svg
114114
:target: https://mybinder.org/v2/gh/CoLRev-Environment/search-query/HEAD?labpath=docs%2Fsource%2Fdemo.ipynb
115115

116-
Functional Overview
117-
=======================
116+
Functional overview
117+
======================
118118

119119
The search-query package supports the entire lifecycle of academic search query management.
120120
Below is a high-level overview of the core functionalities:

docs/source/lint/errors_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Database errors: Web of Science
9898

9999
WOS_0012
100100

101-
Database errors: EBSCOHost
101+
Database errors: EBSCOhost
102102
--------------------------
103103

104104
.. toctree::

docs/source/load.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Load
55

66
Queries can be loaded from strings/files, defined as objects, or retrieved from the internal database.
77

8-
String/File
8+
String/file
99
-------------------------
1010

1111
Search-query can parse queries from strings and JSON query files.

docs/source/platforms/ebsco.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
.. _ebsco:
22

3-
EBSCOHost
3+
EBSCOhost
44
=========
55

6-
EBSCOHost provides access to a wide range of academic databases across disciplines, including business, education, psychology, and health sciences.
6+
EBSCOhost provides access to a wide range of academic databases across disciplines, including business, education, psychology, and health sciences.
77

8-
Run a Query
8+
Run a query
99
-----------
1010

11-
EBSCOHost queries can be constructed using the standard `EBSCOHost advanced search interface <https://search.ebscohost.com/>`_ (requires institutional access).
11+
EBSCOhost queries can be constructed using the standard `EBSCOhost advanced search interface <https://search.ebscohost.com/>`_ (requires institutional access).
1212

1313
When working with `search-query`, extract the **Search terms** from the **Search History** panel or persistent URL for use as the `search_string`.
1414

15-
EBSCOHost query syntax includes field tags such as `AB`, `TI`, `SU`, etc. These should be included directly in the `search_string`.
15+
EBSCOhost query syntax includes field tags such as `AB`, `TI`, `SU`, etc. These should be included directly in the `search_string`.
1616

17-
Store a Query
17+
Store a query
1818
-------------
1919

20-
When storing an EBSCOHost query in a `.json` file or as a string:
20+
When storing an EBSCOhost query in a `.json` file or as a string:
2121

2222
- Use the **Search History** or the **Search Terms** as the `search_string`.
2323

@@ -29,8 +29,8 @@ When storing an EBSCOHost query in a `.json` file or as a string:
2929

3030
Do not use the **persistent link feature**.
3131

32-
List Query Format
33-
--------------------
32+
List query format
33+
-----------------
3434

3535
EBSCOhost supports building **multi-line queries** where individual components are defined as numbered search lines and later combined using references like ``S1 AND S2``. This method is often used in advanced or expert search modes.
3636

@@ -46,7 +46,7 @@ List queries should be formatted as follows:
4646
Each numbered item defines a part of the query using EBSCOhost's field syntax. Later lines can combine them using boolean operators like ``AND``, ``OR``, or ``NOT``, allowing for structured, transparent query design.
4747

4848

49-
Best Practices and Recommendations
49+
Best practices and recommendations
5050
----------------------------------
5151

5252
- **Use field tags** (e.g., `AB`, `TI`) explicitly in the query string.

docs/source/platforms/pubmed.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ PubMed
66

77
PubMed is a free resource supporting the search and retrieval of biomedical and life sciences literature.
88

9-
Run a Query
9+
Run a query
1010
-----------
1111

1212
Queries can be entered using either:
@@ -20,16 +20,16 @@ These interfaces are functionally equivalent for the purposes of `search-query`.
2020

2121
Include field tags explicitly in the `search_string`. Leave the `general_field` empty.
2222

23-
Store a Query
23+
Store a query
2424
-------------
2525

2626
When storing a PubMed query in a `.json` file or as a string:
2727

2828
- Use the content of the **Query box** or **Search details** section as the `search_string`.
2929
- Leave the `general_field` empty.
3030

31-
List Query Format
32-
--------------------
31+
List query format
32+
-----------------
3333

3434
PubMed allows combining previous searches using the search history panel. These list-based queries can reference earlier searches using numbered identifiers (e.g., `#1 OR #2`). In the advanced search interface, such combinations can also be created via the **“Add”** button. List queries are supported by `search-query` parsers.
3535

@@ -42,7 +42,7 @@ List queries should be formatted as follows:
4242
"general_field": ""
4343
}
4444
45-
Best Practices and Recommendations
45+
Best practices and recommendations
4646
----------------------------------
4747

4848
The advanced PubMed interface offers a dropdown for search fields such as `[Title/Abstract]`, `[Author]`, etc. When using this feature:

0 commit comments

Comments
 (0)