fix: Moved private module docs for triggers to the public trigger types

[RobertJacobsonCDC]

The complete documentation for each of the built-in trigger types was on the trigger type's submodule, but because these submodules are private, the docs aren't rendered. The trigger type itself is re-exported from the trigger module. This PR moves the complete docs to the trigger type itself, where it is accessible.

[github-actions]

Benchmark Results

Hyperfine

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
large_sir::baseline	3.3 ± 0.0	3.2	3.4	1.00
large_sir::baseline_households	3.3 ± 0.1	3.2	4.1	1.00 ± 0.04
large_sir::entities	7.4 ± 0.1	7.3	8.2	2.28 ± 0.06
large_sir::households	7.5 ± 0.6	7.1	9.4	2.29 ± 0.17

Criterion

Regressions (slower)

Group	Bench	Param	Change	CI Lower	CI Upper
large_dataset	bench_query_population_indexed_property_entities		12.586%	10.354%	14.335%
sample_entity	sample_entity_multi_property_indexed	1000	8.694%	5.927%	11.473%
large_dataset	bench_filter_unindexed_entity		5.648%	1.696%	9.292%
sample_entity	sample_entity_single_property_indexed	10000	4.124%	3.040%	5.305%
sample_entity	sample_entity_single_property_unindexed	10000	3.254%	2.753%	3.793%
sample_entity	sample_entity_single_property_indexed	100000	3.086%	1.486%	4.877%
sample_entity	sample_entity_single_property_indexed	1000	2.860%	1.470%	4.363%
large_dataset	bench_query_population_derived_property_entities		2.141%	1.474%	2.799%
counts	index_after_adding_entities		2.070%	1.577%	2.606%
indexing	query_people_multiple_individually_indexed_properties_entities		1.336%	1.090%	1.553%

Improvements (faster)

Group	Bench	Param	Change	CI Lower	CI Upper
counts	multi_property_unindexed_entities		-9.910%	-11.572%	-8.189%
sampling	count_and_sampling_single_unindexed_concrete_plus_derived_entiti		-4.283%	-4.490%	-4.081%
indexing	with_query_results_single_indexed_property_entities		-2.851%	-4.134%	-1.617%
sampling	sampling_single_unindexed_concrete_plus_derived_entities		-1.800%	-2.103%	-1.525%

Unchanged / inconclusive (CI crosses 0%)

Group	Bench	Param	Change	CI Lower	CI Upper
sampling	sampling_multiple_l_reservoir_entities		-1.573%	-2.392%	-0.805%
examples	example-basic-infection		-1.183%	-1.707%	-0.722%
counts	single_property_indexed_entities		-1.052%	-1.844%	-0.212%
algorithm_benches	algorithm_sampling_single_known_length		1.005%	-0.587%	2.804%
counts	reindex_after_adding_more_entities		0.979%	0.468%	1.406%
indexing	query_people_indexed_multi-property_entities		0.972%	0.636%	1.347%
counts	concrete_plus_derived_unindexed_entities		-0.846%	-3.298%	0.702%
large_dataset	bench_filter_indexed_entity		-0.807%	-2.048%	0.364%
indexing	with_query_results_multiple_individually_indexed_properties_enti		0.717%	0.275%	1.016%
sampling	sampling_multiple_known_length_entities		0.597%	0.256%	0.920%
sample_entity	sample_entity_multi_property_indexed	100000	-0.597%	-1.329%	0.173%
sampling	sampling_single_unindexed_entities		-0.592%	-0.885%	-0.305%
large_dataset	bench_query_population_multi_unindexed_entities		0.573%	0.160%	0.884%
sample_entity	sample_entity_multi_property_indexed	10000	0.572%	-0.278%	1.450%
large_dataset	bench_query_population_multi_indexed_entities		0.546%	-0.185%	1.266%
sampling	sampling_single_l_reservoir_entities		-0.531%	-1.643%	0.277%
examples	example-births-deaths		-0.489%	-0.691%	-0.286%
indexing	query_people_single_indexed_property_entities		0.437%	0.346%	0.529%
sample_entity	sample_entity_single_property_unindexed	100000	0.423%	-0.277%	1.237%
indexing	with_query_results_indexed_multi-property_entities		0.348%	-0.051%	0.835%
large_dataset	bench_match_entity		-0.347%	-0.853%	0.319%
counts	multi_property_indexed_entities		-0.305%	-0.734%	0.020%
sampling	sampling_multiple_unindexed_entities		0.252%	0.005%	0.498%
sampling	sampling_single_known_length_entities		0.215%	-0.353%	0.735%
sample_entity	sample_entity_whole_population	100000	-0.189%	-1.365%	0.916%
large_dataset	bench_query_population_property_entities		-0.185%	-0.636%	0.136%
algorithm_benches	algorithm_sampling_multiple_known_length		0.166%	-0.109%	0.452%
indexing	query_people_count_multiple_individually_indexed_properties_enti		-0.158%	-0.486%	0.270%
indexing	query_people_count_single_indexed_property_entities		-0.131%	-0.684%	0.474%
algorithm_benches	algorithm_sampling_single_rand_reservoir		0.105%	-0.117%	0.455%
sample_entity	sample_entity_single_property_unindexed	1000	-0.100%	-0.407%	0.266%
algorithm_benches	algorithm_sampling_multiple_l_reservoir		-0.097%	-0.436%	0.247%
sampling	count_and_sampling_single_known_length_entities		0.094%	-0.419%	0.617%
sample_entity	sample_entity_whole_population	10000	0.033%	-1.435%	1.568%
counts	single_property_unindexed_entities		-0.013%	-0.694%	0.659%
algorithm_benches	algorithm_sampling_single_l_reservoir		0.009%	-0.306%	0.332%
indexing	query_people_count_indexed_multi-property_entities		-0.005%	-0.404%	0.275%
sample_entity	sample_entity_whole_population	1000	0.001%	-1.353%	1.262%

Not Compared (no baseline yet)

Group	Bench	Reason
(none)

[github-actions]

Benchmark Results

Hyperfine

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
large_sir::baseline	2.7 ± 0.1	2.6	2.9	1.00
large_sir::baseline_households	2.7 ± 0.1	2.6	2.9	1.01 ± 0.03
large_sir::entities	5.0 ± 0.1	4.9	5.4	1.87 ± 0.05
large_sir::households	4.9 ± 0.1	4.8	5.1	1.81 ± 0.04

Criterion

Regressions (slower)

Group	Bench	Param	Change	CI Lower	CI Upper
counts	single_property_indexed_entities		110.547%	99.319%	119.891%
algorithm_benches	algorithm_sampling_single_known_length		22.719%	17.594%	28.680%
large_dataset	bench_query_population_indexed_property_entities		7.060%	4.018%	10.161%
indexing	with_query_results_multiple_individually_indexed_properties_enti		4.092%	3.585%	4.593%
large_dataset	bench_query_population_multi_indexed_entities		3.190%	2.174%	4.110%
sample_entity	sample_entity_whole_population	1000	2.448%	1.838%	3.154%
sample_entity	sample_entity_whole_population	10000	2.022%	1.427%	2.590%
sampling	sampling_single_unindexed_concrete_plus_derived_entities		1.719%	1.444%	2.014%
sampling	count_and_sampling_single_known_length_entities		1.568%	1.018%	2.090%

Improvements (faster)

Group	Bench	Param	Change	CI Lower	CI Upper
large_dataset	bench_query_population_derived_property_entities		-26.369%	-26.573%	-26.103%
sampling	sampling_single_known_length_entities		-8.968%	-9.697%	-8.285%
examples	example-births-deaths		-4.897%	-7.588%	-2.382%
sample_entity	sample_entity_multi_property_indexed	10000	-3.957%	-4.336%	-3.551%
sample_entity	sample_entity_multi_property_indexed	100000	-3.793%	-4.224%	-3.397%
sample_entity	sample_entity_multi_property_indexed	1000	-3.007%	-3.379%	-2.613%

Unchanged / inconclusive (CI crosses 0%)

Group	Bench	Param	Change	CI Lower	CI Upper
examples	example-basic-infection		-4.395%	-10.109%	0.609%
counts	reindex_after_adding_more_entities		-1.438%	-2.538%	-0.351%
indexing	query_people_count_multiple_individually_indexed_properties_enti		-1.182%	-1.597%	-0.710%
counts	single_property_unindexed_entities		-1.077%	-3.695%	0.559%
indexing	query_people_single_indexed_property_entities		1.066%	0.704%	1.437%
sample_entity	sample_entity_whole_population	100000	0.938%	0.287%	1.638%
counts	index_after_adding_entities		0.932%	0.695%	1.173%
large_dataset	bench_filter_unindexed_entity		-0.908%	-4.837%	2.959%
indexing	query_people_count_indexed_multi-property_entities		-0.861%	-1.017%	-0.683%
sample_entity	sample_entity_single_property_unindexed	1000	0.842%	0.271%	1.442%
sampling	count_and_sampling_single_unindexed_concrete_plus_derived_entiti		-0.836%	-0.907%	-0.762%
sample_entity	sample_entity_single_property_indexed	1000	0.742%	0.290%	1.158%
indexing	query_people_count_single_indexed_property_entities		0.625%	0.190%	1.109%
algorithm_benches	algorithm_sampling_single_l_reservoir		0.505%	0.222%	0.807%
sample_entity	sample_entity_single_property_indexed	100000	-0.490%	-1.240%	0.356%
indexing	with_query_results_single_indexed_property_entities		0.360%	-0.123%	0.854%
large_dataset	bench_match_entity		-0.351%	-2.642%	1.804%
counts	multi_property_indexed_entities		-0.306%	-0.574%	-0.041%
indexing	query_people_indexed_multi-property_entities		-0.283%	-0.692%	0.193%
sampling	sampling_multiple_l_reservoir_entities		-0.273%	-0.394%	-0.160%
counts	multi_property_unindexed_entities		-0.261%	-0.915%	0.312%
algorithm_benches	algorithm_sampling_multiple_known_length		0.259%	-0.363%	1.125%
sampling	sampling_single_unindexed_entities		-0.251%	-0.553%	-0.057%
counts	concrete_plus_derived_unindexed_entities		-0.237%	-0.831%	0.158%
sample_entity	sample_entity_single_property_indexed	10000	-0.216%	-0.740%	0.291%
large_dataset	bench_query_population_property_entities		0.207%	-0.370%	0.759%
sample_entity	sample_entity_single_property_unindexed	100000	0.205%	-0.196%	0.656%
large_dataset	bench_filter_indexed_entity		-0.173%	-2.048%	1.625%
sampling	sampling_single_l_reservoir_entities		-0.171%	-0.329%	-0.015%
sampling	sampling_multiple_unindexed_entities		0.143%	0.043%	0.241%
large_dataset	bench_query_population_multi_unindexed_entities		-0.111%	-0.753%	0.364%
sampling	sampling_multiple_known_length_entities		-0.077%	-0.277%	0.143%
algorithm_benches	algorithm_sampling_single_rand_reservoir		-0.035%	-0.344%	0.293%
indexing	with_query_results_indexed_multi-property_entities		-0.030%	-0.494%	0.647%
indexing	query_people_multiple_individually_indexed_properties_entities		-0.019%	-0.337%	0.296%
algorithm_benches	algorithm_sampling_multiple_l_reservoir		-0.016%	-0.362%	0.337%
sample_entity	sample_entity_single_property_unindexed	10000	-0.016%	-1.193%	0.934%

Not Compared (no baseline yet)

Group	Bench	Reason
(none)