third_party.pigweed.src/pw_assert_basic/docs.rst

.. _module-pw_assert_basic:

===============
pw_assert_basic
===============

--------
Overview
--------
This is a simple assert backend to implement the ``pw_assert`` facade.
docs: Make labels consistent; remove boilerplate - Update labels so they use consistent naming. Instead of the copy-and-pasted `chapter` prefix, name labels with a prefix consistent with what they point to: - "module-" for module - "target-" for targets - "docs-" for general documentation - Remove the unnecessary highlight and default-domain directives. Neither is necessary since the Pigweed docs always specify the language in code snippets and other directives. Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328 Commit-Queue: Wyatt Hepler <hepler@google.com> Reviewed-by: Keir Mierle <keir@google.com> 2020-10-01 01:59:33 +00:00			`.. _module-pw_assert_basic:`
pw_assert: Add design discussion to docs This enhances the assert documentation with information about tradeoffs considered while designing the module. Additionally, provides some guidance to be more explicit that PW_CHECK(a < b) shouldn't be used, and instead PW_CHECK_INT_LT(a, b) should be used. Change-Id: I421700bfa85cb34c874c999245c201cb3337ebb4 2020-06-01 18:59:41 +00:00
pw_assert: Expand documentation coverage Change-Id: Ic3f57f30286ca96fb6d0bc303de39c60322ea663 2020-03-03 18:27:01 +00:00			`===============`
			`pw_assert_basic`
			`===============`

			`--------`
			`Overview`
			`--------`
Update docs First pass at docs to bring them up to date with The Great GN Refactor. More to follow. Change-Id: I02dc977fcdc7bf3efa8fc9080282dee9b1455cdd 2020-06-15 23:30:40 +00:00			This is a simple assert backend to implement the ``pw_assert`` facade.
pw_assert: Expand documentation coverage Change-Id: Ic3f57f30286ca96fb6d0bc303de39c60322ea663 2020-03-03 18:27:01 +00:00