Skip to content

Commit

Permalink
docs: Add naming conventions for certain things.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
cuavas committed Aug 24, 2020
1 parent ec9992e commit 3b5f754
Show file tree
Hide file tree
Showing 4 changed files with 225 additions and 78 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ insert_final_newline = true
tab_width = 4
trim_trailing_whitespace = true

[*.py]
[*.{py,rst}]
indent_style = space
tab_width = 8
17 changes: 9 additions & 8 deletions docs/source/techspecs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ This section covers technical specifications useful to programmers working on MA
.. toctree::
:titlesonly:

layout_files
device_memory_interface
device_rom_interface
device_disasm_interface
floppy
nscsi
luaengine
m6502
naming
layout_files
device_memory_interface
device_rom_interface
device_disasm_interface
floppy
nscsi
luaengine
m6502
Loading

0 comments on commit 3b5f754

Please sign in to comment.