Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

drivers/mtd: improve doc consistency #20184

Merged
merged 3 commits into from
Dec 14, 2023
Merged

drivers/mtd: improve doc consistency #20184

merged 3 commits into from
Dec 14, 2023

Conversation

gschorcht
Copy link
Contributor

Contribution description

This PR provides some small changes in documentation to improve the consistency of documentation for MTD devices.

While fixing PR #19786, I realized that the list of MTD devices is inconsistent:

  • Some entries use "MTD wrapper for ..."
  • Some entries use "mtd wrapper for ..."
  • Other entries just use "xxxx MTD"
  • SAM0 SDHC is just listed as file
  • The MTD wrapper for emulated MTD devices isn't listed at all but part of the MTD main page by acciedent

Bildschirmfoto vom 2023-12-14 15-23-12

This PR tries to make the list a bit more consistent to improve its readability.

Bildschirmfoto vom 2023-12-14 15-22-24

I'm a bit unsure about Serial NOR flash which is also just a MTD.

Testing procedure

Generae the doc and check the output.

Issues/PRs references

@github-actions github-actions bot added Platform: ARM Platform: This PR/issue effects ARM-based platforms Area: drivers Area: Device drivers Area: cpu Area: CPU/MCU ports labels Dec 14, 2023
@gschorcht gschorcht added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation labels Dec 14, 2023
@riot-ci
Copy link

riot-ci commented Dec 14, 2023 •
edited
Loading

Murdock results

✔️ PASSED

aabc331 drivers/mtd: improve doc consistency for MTDs

Success Failures Total Runtime
1 0 1 56s

Artifacts

@gschorcht gschorcht force-pushed the drivers/mtd/improve_doc_consistency branch from 1788848 to aabc331 Compare December 14, 2023 16:27
@gschorcht gschorcht added this pull request to the merge queue Dec 14, 2023
Merged via the queue into RIOT-OS:master with commit 4e291c4 Dec 14, 2023
25 checks passed
@gschorcht gschorcht deleted the drivers/mtd/improve_doc_consistency branch December 18, 2023 21:31
@MrKevinWeiss MrKevinWeiss added this to the Release 2024.01 milestone Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benpicco benpicco benpicco approved these changes

@dylad dylad Awaiting requested review from dylad dylad is a code owner

@keestux keestux Awaiting requested review from keestux keestux is a code owner

Assignees
No one assigned
Labels
Area: cpu Area: CPU/MCU ports Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Platform: ARM Platform: This PR/issue effects ARM-based platforms Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
Release 2024.01
Development

Successfully merging this pull request may close these issues.
4 participants
@gschorcht @riot-ci @benpicco @MrKevinWeiss