Skip to content

Commit 5b7d0d0

Browse files
committed
fix: add bibliography entry;
delete unused citations
1 parent 012deee commit 5b7d0d0

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

src/coding-guidelines/types-and-traits.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -282,14 +282,12 @@ Types and Traits
282282
}
283283
284284
.. bibliography::
285+
:id: bib_UnionFieldValidity
286+
:status: draft
285287

286-
.. [RUST-REF-UNION] The Rust Project Developers. “Rust Reference: Unions.” *The Rust Reference*, n.d. https://doc.rust-lang.org/reference/items/unions.html.
287-
288-
.. [RUST-REF-UB] The Rust Project Developers. “Rust Reference: Behavior Considered Undefined.” *The Rust Reference*, n.d. https://doc.rust-lang.org/reference/behavior-considered-undefined.html.
289-
290-
.. [UCG-VALIDITY] Rust Unsafe Code Guidelines Working Group. “Validity and Safety Invariant.” *Rust Unsafe Code Guidelines*, n.d. https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#validity-and-safety-invariant.
288+
.. [RUST-REF-UNION] The Rust Project Developers. “Rust Reference: Unions.” *The Rust Reference*, n.d. https://doc.rust-lang.org/reference/items/unions.html.
289+
.. [UCG-VALIDITY] Rust Unsafe Code Guidelines Working Group. “Validity and Safety Invariant.” *Rust Unsafe Code Guidelines*, n.d. https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#validity-and-safety-invariant.
291290
292-
.. [RUST-NOMICON-UNION] The Rust Project Developers. “Unions.” *The Rustonomicon*, n.d. https://doc.rust-lang.org/nomicon/unions.html.
293291
294292
295293
.. guideline:: Use strong types to differentiate between logically distinct values

src/conf.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@
6262
"color": "#729FCF",
6363
"style": "node",
6464
},
65+
{
66+
"directive": "bibliography",
67+
"title": "Bibliography",
68+
"prefix": "bib_",
69+
"color": "#729FCF",
70+
"style": "node",
71+
},
6572
]
6673

6774
# Define custom sections for needs
@@ -89,7 +96,7 @@
8996
}
9097

9198
# Make sure these sections are included in the JSON
92-
needs_extra_sections = ["rationale", "compliant_example", "non_compliant_example"]
99+
needs_extra_sections = ["rationale", "compliant_example", "non_compliant_example", "bibliography"]
93100

94101
needs_statuses = [
95102
dict(name="draft", description="This guideline is in draft stage", color="#999999"),

0 commit comments

Comments
 (0)