You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+35-8Lines changed: 35 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,13 +53,11 @@ References:
53
53
54
54
### 2. Units and prefixes:
55
55
56
-
Use Binary Prefixes (Ki, Mi) for Bytes. E.g.:
57
-
58
-
```
59
-
1 MiB = 2^20 bytes = 1,048,576 bytes
60
-
1 KiB = 2^10 bytes = 1,024 bytes
61
-
```
62
-
56
+
- Use binary prefixes (Ki, Mi) for Bytes. E.g.:
57
+
```
58
+
1 MiB = 2^20 bytes = 1,048,576 bytes
59
+
1 KiB = 2^10 bytes = 1,024 bytes
60
+
```
63
61
- Abbreviate bytes as "B" when used with a prefix. Spell out bits as "bits", even when used with a prefix, to avoid ambiguity. When used as a unit suffix, unit names are always singular, so it should be "20 kbit", not "20 kbits". (Also, "bytes" as a word is fine, just like "30 meters" is a valid way of talking about that length. But "Mbyte" and the like should go away.)
64
62
- Hexadecimal values are uppercase and prefixed with `$`: e.g. `$ABCD`. To prevent clutter, don't use a prefix for hex numbers when it's clear from the context that a number is hexadecimal. For example, addresses and lists of opcodes. In those cases, zero-pad, even for smaller numbers: `0000-3FFF` instead of `0-3FFF`.
65
63
- Put a space between numbers and their unit (ISO).
@@ -111,6 +109,35 @@ Those should either be written out (1 to 42), or use an "n-dash" `–` (can also
It also follows that descriptions should not use commas outside of acting as separators for the aforementioned lists.
136
+
137
+
A convenience feature is provided for linking to sections, even across files: any link whose URL is only an anchor will be converted into an actual link to the section.
138
+
For example, `[sample link text](<#014B — Old licensee code>)` will automatically be turned into `[sample link text](The_Cartridge_Header.html#014b--old-licensee-code)`.
139
+
References to missing sections will be left as-is, and ambiguous references resolved arbitrarily (this should eventually change).
140
+
(Note that the use of angle brackets `<>` here is [a CommonMark feature](https://spec.commonmark.org/0.30/#link-destination) to allow spaces in the link destination.)
114
141
115
142
## SVG
116
143
@@ -167,4 +194,4 @@ Then, add a directive to embed the file's contents, for example `{{#include imgs
167
194
Replace `imgs/ppu_modes_timing.svg` with the path to the SVG from the `src/` folder, and `2` with the line number the opening `<svg>` tag is on.
168
195
169
196
A word of caution about the directive's placement: if it is surrounded by empty lines, the image will be outside of any paragraphs, within the document's main flow.
170
-
However, if it is adjacent to a line of text, it may be placed within the paragraph, which is likely not what you want.
197
+
However, if it is adjacent to a line of text, it may be placed within the paragraph, which is likely not what you want.
0 commit comments