Skip to content

Commit 9701aea

Browse files
committed
doc: Move docs to doc for brevity
1 parent fd44e45 commit 9701aea

11 files changed

Lines changed: 10 additions & 10 deletions

.aider.conf.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Allow editing of tmp files that are ignored by git.
22
add-gitignore-files: true
33

4-
read: [README.md,CONVENTIONS.md,src/01_schema.sql,docs/api.md,docs/semantical_principles.md]
4+
read: [README.md,CONVENTIONS.md,src/01_schema.sql,doc/api.md,doc/semantical_principles.md]
55
file: [todo.md,tmp/journal.md]
66

77
# The code quality for large SQL file edits is not great,

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ This validation is implemented using a `CHECK` constraint on the regular table,
265265

266266
### Level 3: The Deep Dive - Complete API Reference
267267

268-
For a complete, auto-generated reference of all functions and procedures, please see the [API Documentation](./docs/api.md).
268+
For a complete, auto-generated reference of all functions and procedures, please see the [API Documentation](./doc/api.md).
269269

270270
## Usage
271271

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

expected/098_generate_api_docs.out

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ GRANT CREATE ON SCHEMA public TO PUBLIC;
2929
\t
3030
\a
3131
-- Redirect output to the API documentation file
32-
\o docs/api.md
32+
\o doc/api.md
3333
-- Generate the header for the documentation file
3434
SELECT '# sql_saga API Reference
3535

@@ -166,10 +166,10 @@ FROM (
166166
\t
167167
\a
168168
-- A simple select to confirm the script ran
169-
SELECT 'API documentation generated in docs/api.md' AS result;
170-
result
171-
--------------------------------------------
172-
API documentation generated in docs/api.md
169+
SELECT 'API documentation generated in doc/api.md' AS result;
170+
result
171+
-------------------------------------------
172+
API documentation generated in doc/api.md
173173
(1 row)
174174

175175
-- Check for any public functions that have not been assigned to a category

sql/098_generate_api_docs.sql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
\a
99

1010
-- Redirect output to the API documentation file
11-
\o docs/api.md
11+
\o doc/api.md
1212

1313
-- Generate the header for the documentation file
1414
SELECT '# sql_saga API Reference
@@ -156,7 +156,7 @@ FROM (
156156
\a
157157

158158
-- A simple select to confirm the script ran
159-
SELECT 'API documentation generated in docs/api.md' AS result;
159+
SELECT 'API documentation generated in doc/api.md' AS result;
160160

161161
-- Check for any public functions that have not been assigned to a category
162162
SELECT 'Uncategorized API functions found. Please add them to a category in `sql/80_generate_api_docs.sql`:' AS " ",

0 commit comments

Comments
 (0)