Skip to content

Commit 33ca899

Browse files
christophdbclaude
andcommitted
Fix ~120 typos, grammar errors, broken links, and code bugs across documentation
- Fix broken links (wrong paths in Python examples index, misspelled filenames) - Fix code bugs in examples (missing append(), wrong variable names, Python False) - Fix Python syntax used in JavaScript code blocks (True/False/None, keyword args) - Fix broken markdown tables, admonitions, and formatting across multiple files - Fix typos and grammar errors (ink→link, wether→whether, .venv→.env, etc.) - Add UPDATE SET limitation note (only constants supported, no functions) - Correct wrong example outputs in SQL functions reference Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 31884e8 commit 33ca899

38 files changed

Lines changed: 124 additions & 125 deletions

‎docs/clients/javascript/columns.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Every table in a base contains columns. The following calls are available to int
2525

2626
__Example__
2727
``` js
28-
const col = await base.getColumnsByName('Table1', 'Name');
28+
const col = await base.getColumnByName('Table1', 'Name');
2929
```
3030

3131
!!! question "getColumnsByType"

‎docs/clients/javascript/constants.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ In the script there may be some constants we need to know.
2525
ColumnTypes.LAST_MODIFIER // last modifier
2626
ColumnTypes.MTIME // modify time
2727
ColumnTypes.GEOLOCATION // geolocation
28-
ColumnTypes.AUTO_NUMBER // auto munber
28+
ColumnTypes.AUTO_NUMBER // auto number
2929
ColumnTypes.URL // URL
3030
```

‎docs/clients/javascript/metadata.md‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,35 @@ Metadata delivers the complete structure of a base with tables, views and column
1717
'tables': [{
1818
'_id': '4krH',
1919
'name': 'Contact',
20-
'is_header_locked': False,
20+
'is_header_locked': false,
2121
'columns': [{
2222
'key': '0000',
2323
'type': 'text',
2424
'name': 'Name',
25-
'editable': True,
25+
'editable': true,
2626
'width': 200,
27-
'resizable': True,
28-
'draggable': True,
29-
'data': None,
27+
'resizable': true,
28+
'draggable': true,
29+
'data': null,
3030
'permission_type': '',
3131
'permitted_users': []
3232
}, {
3333
'key': 'M31F',
3434
'type': 'text',
3535
'name': 'Email',
36-
'editable': True,
36+
'editable': true,
3737
'width': 200,
38-
'resizable': True,
39-
'draggable': True,
40-
'data': None,
38+
'resizable': true,
39+
'draggable': true,
40+
'data': null,
4141
'permission_type': '',
4242
'permitted_users': []
4343
}],
4444
'views': [{
4545
'_id': '0000',
4646
'name': 'Default view',
4747
'type': 'table',
48-
'is_locked': False,
48+
'is_locked': false,
4949
'filter_conjunction': 'And',
5050
'filters': [],
5151
'sorts': [],
@@ -63,5 +63,3 @@ Metadata delivers the complete structure of a base with tables, views and column
6363
}]
6464
}
6565
```
66-
67-
###

‎docs/clients/javascript/tables.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
!!! question "renameTable"
4343

4444
``` js
45-
base.renameTable(oldNname: String, newName: String)
45+
base.renameTable(oldName: String, newName: String)
4646
```
4747

4848
__Example__

‎docs/clients/php_api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ SeaTable's API exposes the entire SeaTable features via a standardized programma
44

55
!!! info "Auto generated from openapi specification"
66

7-
Since April 2024, we auto generate this SeaTable php client from our public available openapi specification. The advantage is that, the php client automatically contains all available API endpoints and we save a lot of programming capacity. Also we could generate more api clients for other programming languages in no time with the same feature set. The disadvantage is, that with this new client we removed some convenitent functions for authentication and the new version is not compatible at all with the version v0.2 and earlier.
7+
Since April 2024, we auto generate this SeaTable php client from our public available openapi specification. The advantage is that the PHP client automatically contains all available API endpoints and we save a lot of programming capacity. Also we could generate more api clients for other programming languages in no time with the same feature set. The disadvantage is, that with this new client we removed some convenient functions for authentication and the new version is not compatible at all with the version v0.2 and earlier.
88

99
## Installation
1010

@@ -182,5 +182,5 @@ You can find detailed documentation for all endpoints including auto-generated e
182182
- [Base](https://github.com/seatable/seatable-api-php/blob/main/README_Base.md)
183183
- [File](https://github.com/seatable/seatable-api-php/blob/main/README_File.md)
184184
- [SysAdmin](https://github.com/seatable/seatable-api-php/blob/main/README_SysAdmin.md)
185-
- [TeamAdmin](https://github.com/seatable/seatable-api-php/blob/main/README_TeamAmin.md)
185+
- [TeamAdmin](https://github.com/seatable/seatable-api-php/blob/main/README_TeamAdmin.md)
186186
- [User](https://github.com/seatable/seatable-api-php/blob/main/README_User.md)

‎docs/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Developer Manual caters to **developers** interested in utilizing custom scr
1010

1111
You don't feel familiar enough with coding or with SeaTable? Depending on your actual skills, knowledge and aims, here are some suggested starting points:
1212

13-
- You would like to get started but currently have no programming knowledge? We invite you to consult the [Coding for beginners page](/introduction/coding_for_beginnners)
13+
- You would like to get started but currently have no programming knowledge? We invite you to consult the [Coding for beginners page](/introduction/coding_for_beginners)
1414

1515
- You are new to SeaTable? Do not hesitate to consult [SeaTable's user manual](https://seatable.com/help/) to get more familiar with it.
1616

@@ -55,9 +55,9 @@ The actual authentication depends on the development approach one chooses.
5555

5656
=== "Scripts"
5757

58-
JavaScript scripts does not require any authentication at all because these scripts are executed in the browser of the user and the user has to be authenticated already.
58+
JavaScript scripts do not require any authentication at all because these scripts are executed in the browser of the user and the user has to be authenticated already.
5959

60-
Python scripts require an authentication to get data from the base, but the `context` objects contains everything for an easy authentication.
60+
Python scripts require an authentication to get data from the base, but the `context` object contains everything for an easy authentication.
6161

6262
=== "Plugins"
6363

‎docs/introduction/coding_for_beginners.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ These paid resources, though requiring a small investment, often provide:
3232

3333
Remember, while free tutorials are abundant, investing in a structured resource can significantly expedite your learning process and provide a solid understanding of programming fundamentals essential for SeaTable development.
3434

35-
!!! info "This are personal recommendations"
35+
!!! info "These are personal recommendations"
3636

37-
The following sources does not contain any affiliate links and we do not earn any money from these recommendations. These are just good sources that we have used ourselves in the past.
37+
The following sources do not contain any affiliate links and we do not earn any money from these recommendations. These are just good sources that we have used ourselves in the past.
3838

3939
=== "JavaScript"
4040

@@ -97,13 +97,13 @@ You can take the following python code and copy&paste it to SeaTable. It will re
9797
for table in metadata['tables']:
9898
print('.')
9999
print("Table: "+table['name']+" (ID: "+table['_id']+")")
100-
for column in table['columns']:
101-
link_target = ""
102-
if column['type'] == "link":
103-
link_target = " --> "+column['data']['other_table_id']
104-
if column['data']['other_table_id'] == table['_id']:
105-
link_target = " --> "+column['data']['table_id']
106-
print(" --> "+column['name']+" ("+column['type']+link_target+")")
100+
for column in table['columns']:
101+
link_target = ""
102+
if column['type'] == "link":
103+
link_target = " --> "+column['data']['other_table_id']
104+
if column['data']['other_table_id'] == table['_id']:
105+
link_target = " --> "+column['data']['table_id']
106+
print(" --> "+column['name']+" ("+column['type']+link_target+")")
107107
```
108108

109109
=== "Output example"

‎docs/introduction/get_support.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Get support
22

3-
Next to this developer guide there are more documentations available. To learn more about the usage or SeaTable, the installation of your own server or the SeaTable API, please refer to their respective manuals:
3+
Next to this developer guide there are more documentations available. To learn more about the usage of SeaTable, the installation of your own server or the SeaTable API, please refer to their respective manuals:
44

55
- [SeaTable User Manual](https://help.seatable.com) detailing how to use SeaTable (with a special section about [scripts](https://seatable.com/help/scripts/))
66
- [SeaTable Admin Manual](https://admin.seatable.com) covering all relevant admin topics, from installation, configuration, upgrade, and maintenance

‎docs/scripts/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Scripts are used to interact with the data in a base. SeaTable supports scripts
66

77
| | JavaScript | Python |
88
|-----------------------|-------------|------------|
9-
| Requirements | None | Eventually `seatable-api` library or [Python Pipeline](https://admin.seatable.com/installation/components/python-pipeline/) (see Execution environment) |
9+
| Requirements | None | Optionally `seatable-api` library or [Python Pipeline](https://admin.seatable.com/installation/components/python-pipeline/) (see Execution environment) |
1010
| Data operations | Simple (mainly tailored for single-line operations) | More complex (more available operations, possibility of using external libraries) |
1111
| Execution environment | In SeaTable | - In SeaTable (self-hosted with the [Python Pipeline](https://admin.seatable.com/installation/components/python-pipeline/) installed, or Cloud)<br>- [Locally](https://developer.seatable.com/scripts/python/common_questions/#how-to-make-the-script-support-both-local-and-cloud-run) or on a server (need to install `seatable-api` library) |
1212
| Authentication | Not needed | Needed |
@@ -24,6 +24,6 @@ Here are some additional help articles from the [User Manual's scripts section](
2424
- [Run script manually, by button or by automation](https://seatable.com/help/skript-manuell-per-schaltflaeche-oder-automation-ausfuehren/)
2525
- [The execution log of scripts](https://seatable.com/help/das-ausfuehrungslog-von-skripten/)
2626

27-
You'll find in this manual a JavaScript and a Python section. For both of them, each chapter provides you with explanations about the available objects and methods (description with the eventual arguments and one or more simple use cases).
27+
You'll find in this manual a JavaScript and a Python section. For both of them, each chapter provides you with explanations about the available objects and methods (description with the optional arguments and one or more simple use cases).
2828

2929
Multiple [JavaScript](../scripts/javascript/examples/index.md) and [Python](../scripts/python/examples/index.md) examples should help you to start immediately and get a feeling about the possibilities.

‎docs/scripts/javascript/objects/context.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Context
22

3-
When the script runs, the `context` object context-related elements. The usage is as follows.
3+
When the script runs, the `context` object provides context-related elements. The usage is as follows.
44

55
!!! abstract "currentTable"
66

0 commit comments

Comments
 (0)