Skip to content

Commit 7a6c975

Browse files
committed
Fix #57 - Lowercasing inline keywords in text and a few code samples that automatic script didn't handle. Fixed a few typos along the way.
1 parent c2f4762 commit 7a6c975

File tree

57 files changed

+166
-164
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+166
-164
lines changed

docs/2-naming-conventions/naming-conventions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
4. Avoid long abbreviations. Abbreviations should be shorter than 5 characters.
99
5. Any abbreviations must be widely known and accepted.
1010
6. Create a glossary with all accepted abbreviations.
11-
7. Never use ORACLE keywords as names. A list of ORACLEs keywords may be found in the dictionary view `V$RESERVED_WORDS`.
12-
8. Avoid adding redundant or meaningless prefixes and suffixes to identifiers.<br/>Example: `CREATE TABLE emp_table`.
11+
7. Never use ORACLE keywords as names. A list of ORACLEs keywords may be found in the dictionary view `v$reserved_words`.
12+
8. Avoid adding redundant or meaningless prefixes and suffixes to identifiers.<br/>Example: `create table emp_table`.
1313
9. Always use one spoken language (e.g. English, German, French) for all objects in your application.
1414
10. Always use the same names for elements with the same meaning.
1515

docs/3-coding-style/coding-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Rule | Description
99
1 | Keywords and names are written in lowercase[^2].
1010
2 | 3 space indention[^3].
1111
3 | One command per line.
12-
4 | Keywords `LOOP`, `ELSE`, `ELSIF`, `END IF`, `WHEN` on a new line.
12+
4 | Keywords `loop`, `else`, `elsif`, `end if`, `when` on a new line.
1313
5 | Commas in front of separated elements.
1414
6 | Call parameters aligned, operators aligned, values aligned.
1515
7 | SQL keywords are right aligned within a SQL command.

docs/4-language-usage/1-general/g-1020.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
Use a label directly in front of loops and nested anonymous blocks:
99

1010
* To give a name to that portion of code and thereby self-document what it is doing.
11-
* So that you can repeat that name with the END statement of that block or loop.
11+
* So that you can repeat that name with the `end` statement of that block or loop.
1212

1313
## Example (bad)
1414

docs/4-language-usage/1-general/g-1060.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
## Reason
77

8-
It is an extremely dangerous practice to store ROWIDs in a table, except for some very limited scenarios of runtime duration. Any manually explicit or system generated implicit table reorganization will reassign the row's ROWID and break the data consistency.
8+
It is an extremely dangerous practice to store `rowid`'s in a table, except for some very limited scenarios of runtime duration. Any manually explicit or system generated implicit table reorganization will reassign the row's `rowid` and break the data consistency.
99

10-
Instead of using ROWID for later reference to the original row one should use the primary key column(s).
10+
Instead of using `rowid` for later reference to the original row one should use the primary key column(s).
1111

1212
## Example (bad)
1313

docs/4-language-usage/2-variables-and-types/1-general/g-2110.md

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

66
## Reason
77

8-
Changing the size of the database column last_name in the employees table from `VARCHAR2(20)` to `VARCHAR2(30)` will result in an error within your code whenever a value larger than the hard coded size is read from the table. This can be avoided using anchored declarations.
8+
Changing the size of the database column last_name in the employees table from `varchar2(20)` to `varchar2(30)` will result in an error within your code whenever a value larger than the hard coded size is read from the table. This can be avoided using anchored declarations.
99

1010
## Example (bad)
1111

docs/4-language-usage/2-variables-and-types/1-general/g-2130.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Your code will be easier to read as the usage of a variable/constant may be deri
1414
Type | Usage
1515
------------------ | -----
1616
`ora_name_type` | Object corresponding to the ORACLE naming conventions (table, variable, column, package, etc.).
17-
max_vc2_type | String variable with maximal VARCHAR2 size.
17+
`max_vc2_type` | String variable with maximal VARCHAR2 size.
1818
`array_index_type` | Best fitting data type for array navigation.
1919
`id_type` | Data type used for all primary key (id) columns.
2020

docs/4-language-usage/2-variables-and-types/1-general/g-2140.md

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

66
## Reason
77

8-
Variables are initialized to NULL by default.
8+
Variables are initialized to `null` by default.
99

1010
## Example (bad)
1111

docs/4-language-usage/2-variables-and-types/1-general/g-2150.md

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

66
## Reason
77

8-
The NULL value can cause confusion both from the standpoint of code review and code execution. You must always use the `IS NULL` or `IS NOT NULL` syntax when you need to check if a value is or is not `NULL`.
8+
The `null` value can cause confusion both from the standpoint of code review and code execution. You must always use the `is null` or `is not null` syntax when you need to check if a value is or is not `null`.
99

1010
## Example (bad)
1111

docs/4-language-usage/2-variables-and-types/1-general/g-2190.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
## Reason
77

8-
Be careful about your use of Oracle-specific data types like `ROWID` and `UROWID`. They might offer a slight improvement in performance over other means of identifying a single row (primary key or unique index value), but that is by no means guaranteed.
8+
Be careful about your use of Oracle-specific data types like `rowid` and `urowid`. They might offer a slight improvement in performance over other means of identifying a single row (primary key or unique index value), but that is by no means guaranteed.
99

10-
Use of `ROWID` or `UROWID` means that your SQL statement will not be portable to other SQL databases. Many developers are also not familiar with these data types, which can make the code harder to maintain.
10+
Use of `rowid` or `urowid` means that your SQL statement will not be portable to other SQL databases. Many developers are also not familiar with these data types, which can make the code harder to maintain.
1111

1212
## Example (bad)
1313

docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2210.md

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

66
## Reason
77

8-
If you do not specify precision `NUMBER` is defaulted to 38 or the maximum supported by your system, whichever is less. You may well need all this precision, but if you know you do not, you should specify whatever matches your needs.
8+
If you do not specify precision `number` is defaulted to 38 or the maximum supported by your system, whichever is less. You may well need all this precision, but if you know you do not, you should specify whatever matches your needs.
99

1010
## Example (bad)
1111

0 commit comments

Comments
 (0)