Skip to content

Commit 3b5f754

Browse files
committed
docs: Add naming conventions for certain things.
This isn’t supposed to be too prescriptive. The C++ stuff just codifies some things we’ve managed to mostly agree on for public interfaces. The stuff for titles/descriptions is also just codifying existing rules so there’s something to point people towards. This will need to be refined as we go forward.
1 parent ec9992e commit 3b5f754

File tree

4 files changed

+225
-78
lines changed

4 files changed

+225
-78
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ insert_final_newline = true
88
tab_width = 4
99
trim_trailing_whitespace = true
1010

11-
[*.py]
11+
[*.{py,rst}]
1212
indent_style = space
1313
tab_width = 8

docs/source/techspecs/index.rst

+9-8
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ This section covers technical specifications useful to programmers working on MA
66
.. toctree::
77
:titlesonly:
88

9-
layout_files
10-
device_memory_interface
11-
device_rom_interface
12-
device_disasm_interface
13-
floppy
14-
nscsi
15-
luaengine
16-
m6502
9+
naming
10+
layout_files
11+
device_memory_interface
12+
device_rom_interface
13+
device_disasm_interface
14+
floppy
15+
nscsi
16+
luaengine
17+
m6502

0 commit comments

Comments
 (0)