improve docs with snipdoc #1145

	name: CI

	on:
	push:
	branches:
	- master
	pull_request:

	env:
	RUST_TOOLCHAIN: stable
	TOOLCHAIN_PROFILE: minimal

	jobs:
	rustfmt:
	name: Check Style
	runs-on: ubuntu-latest

	permissions:
	contents: read

	steps:
	- name: Checkout the code
	uses: actions/checkout@v4
	- uses: actions-rs/toolchain@v1
	with:
	profile: ${{ env.TOOLCHAIN_PROFILE }}
	toolchain: ${{ env.RUST_TOOLCHAIN }}
	override: true
	components: rustfmt
	- name: Run cargo fmt
	uses: actions-rs/cargo@v1
	with:
	command: fmt
	args: --all -- --check

	clippy:
	name: Run Clippy
	needs: [rustfmt]
	runs-on: ubuntu-latest

	permissions:
	contents: read

	steps:
	- name: Checkout the code
	uses: actions/checkout@v4
	- uses: actions-rs/toolchain@v1
	with:
	profile: ${{ env.TOOLCHAIN_PROFILE }}
	toolchain: ${{ env.RUST_TOOLCHAIN }}
	override: true
	- name: Setup Rust cache
	uses: Swatinem/rust-cache@v2
	- name: Run cargo clippy
	uses: actions-rs/cargo@v1
	with:
	command: clippy
	args: --all-features -- -D warnings -W clippy::pedantic -W clippy::nursery -W rust-2018-idioms

	test:
	name: Run Tests
	needs: [rustfmt, clippy]
	runs-on: ubuntu-latest

	permissions:
	contents: read

	steps:
	- name: Checkout the code
	uses: actions/checkout@v4
	- uses: actions-rs/toolchain@v1
	with:
	profile: ${{ env.TOOLCHAIN_PROFILE }}
	toolchain: ${{ env.RUST_TOOLCHAIN }}
	override: true
	- name: Setup Rust cache
	uses: Swatinem/rust-cache@v2
	- name: Run cargo test
	uses: actions-rs/cargo@v1
	with:
	command: test
	args: --all-features --all

Provide feedback