From 3459b41fed242ffa67b5df99495106622b9bb885 Mon Sep 17 00:00:00 2001 From: Diego Barrios Romero Date: Fri, 16 Nov 2018 18:33:45 +0100 Subject: [PATCH] Move alarm section up in documentation --- README.md | 10 +++++----- src/lib.rs | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e3e3df1..cfcf7ce 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,16 @@ This driver allows you to: - Clear the has-been-stopped flag. See `clear_has_been_stopped_flag`. - Set and read the aging offset. See `set_aging_offset`. - Select the function of the INT/SQW output pin. See `use_int_sqw_output_as_interrupt`. -- Wave generation: - - Enable and disable the square-wave generation. See `enable_square_wave`. - - Select the square-wave frequency. See `set_square_wave_frequency`. - - Enable and disable the 32kHz output. See `enable_32khz_output`. - - Enable and disable the 32kHz output when battery powered. See `enable_32khz_output_on_battery`. - Alarms: - Set alarms 1 and 2 with several matching policies. See `set_alarm1_day`. - Read whether alarms 1 or 2 have matched. See `has_alarm1_matched`. - Clear flag indicating that alarms 1 or 2 have matched. See `clear_alarm1_matched_flag`. - Enable and disable alarms 1 and 2 interrupt generation. See `enable_alarm1_interrupts`. +- Wave generation: + - Enable and disable the square-wave generation. See `enable_square_wave`. + - Select the square-wave frequency. See `set_square_wave_frequency`. + - Enable and disable the 32kHz output. See `enable_32khz_output`. + - Enable and disable the 32kHz output when battery powered. See `enable_32khz_output_on_battery`. - Temperature conversion: - Read the temperature. See `get_temperature`. - Force a temperature conversion and time compensation. See `convert_temperature`. diff --git a/src/lib.rs b/src/lib.rs index b2a775f..c730087 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -12,16 +12,16 @@ //! - Clear the has-been-stopped flag. See [`clear_has_been_stopped_flag`]. //! - Set and read the aging offset. See [`set_aging_offset`]. //! - Select the function of the INT/SQW output pin. See [`use_int_sqw_output_as_interrupt`]. -//! - Wave generation: -//! - Enable and disable the square-wave generation. See [`enable_square_wave`]. -//! - Select the square-wave frequency. See [`set_square_wave_frequency`]. -//! - Enable and disable the 32kHz output. See [`enable_32khz_output`]. -//! - Enable and disable the 32kHz output when battery powered. See [`enable_32khz_output_on_battery`]. //! - Alarms: //! - Set alarms 1 and 2 with several matching policies. See [`set_alarm1_day`]. //! - Read whether alarms 1 or 2 have matched. See [`has_alarm1_matched`]. //! - Clear flag indicating that alarms 1 or 2 have matched. See [`clear_alarm1_matched_flag`]. //! - Enable and disable alarms 1 and 2 interrupt generation. See [`enable_alarm1_interrupts`]. +//! - Wave generation: +//! - Enable and disable the square-wave generation. See [`enable_square_wave`]. +//! - Select the square-wave frequency. See [`set_square_wave_frequency`]. +//! - Enable and disable the 32kHz output. See [`enable_32khz_output`]. +//! - Enable and disable the 32kHz output when battery powered. See [`enable_32khz_output_on_battery`]. //! - Temperature conversion: //! - Read the temperature. See [`get_temperature`]. //! - Force a temperature conversion and time compensation. See [`convert_temperature`].