Merge pull request #87 from ssnover/fix-documentation-page-example

Fix the example section of the cargo generated documentation
This commit is contained in:
Kedar Sovani 2023-08-16 11:54:31 +05:30 committed by GitHub
commit 4c347c0c0b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -23,7 +23,8 @@
//! Currently Ethernet based transport is supported. //! Currently Ethernet based transport is supported.
//! //!
//! # Examples //! # Examples
//! TODO: Fix once new API has stabilized a bit //! ```ignore
//! /// TODO: Fix once new API has stabilized a bit
//! use rs_matter::{Matter, CommissioningData}; //! use rs_matter::{Matter, CommissioningData};
//! use rs_matter::data_model::device_types::device_type_add_on_off_light; //! use rs_matter::data_model::device_types::device_type_add_on_off_light;
//! use rs_matter::data_model::cluster_basic_information::BasicInfoConfig; //! use rs_matter::data_model::cluster_basic_information::BasicInfoConfig;
@ -65,6 +66,7 @@
//! } //! }
//! // Start the Matter Daemon //! // Start the Matter Daemon
//! // matter.start_daemon().unwrap(); //! // matter.start_daemon().unwrap();
//! ```
//! //!
//! Start off exploring by going to the [Matter] object. //! Start off exploring by going to the [Matter] object.
#![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(not(feature = "std"), no_std)]