car docs: docs-only footnote flag (#26335)

docs-only footnotes
This commit is contained in:
Shane Smiskol
2022-11-02 18:56:26 -07:00
committed by GitHub
parent e634afb719
commit 735af656a0

View File

@@ -68,14 +68,14 @@ class Harness(Enum):
none = "None"
CarFootnote = namedtuple("CarFootnote", ["text", "column"], defaults=[None])
CarFootnote = namedtuple("CarFootnote", ["text", "column", "docs_only"], defaults=(None, False))
class CommonFootnote(Enum):
EXP_LONG_AVAIL = CarFootnote(
"Experimental openpilot longitudinal control is available behind a toggle; the toggle is only available in non-release branches such as `master-ci`. " +
"Using openpilot longitudinal may disable Automatic Emergency Braking (AEB).",
Column.LONGITUDINAL)
Column.LONGITUDINAL, docs_only=True)
def get_footnotes(footnotes: List[Enum], column: Column) -> List[Enum]: