esp-hal icon indicating copy to clipboard operation
esp-hal copied to clipboard

Update module documentation

Open SergioGasquez opened this issue 7 months ago • 1 comments

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request. To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • [x] I have updated existing examples or added new ones (if applicable).
  • [x] I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • [x] My changes were added to the CHANGELOG.md in the proper section.
  • [x] My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Description

First PR for unifying the format of module documentation. Used this format:

//! # Peripheral Name (Peripheral Acronym)
//!
//! ## Overview
//! Small description of the peripheral, see ESP-IDF docs or TRM 
//! 
//! ## Configuration
//! Explain how can the peripheral be configured, and which parameters can be configured
//! 
//! ## Usage
//! Explain if we implement any external traits
//! 
//! ## Examples
//! ### Name of the Example
//! Small description of the example if needed
//! ```rust, no_run
//! ...
//! ```
//! ## Implementation State
//! Missing features...

Still a lot of modules to be updated, but this is already a big PR (sorry)

Testing

Built the documentation and ran the doc-tests.

SergioGasquez avatar Jul 05 '24 14:07 SergioGasquez