-
Notifications
You must be signed in to change notification settings - Fork 8k
doc: fs: document preconditions with fs_open & fs_opendir #97291
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.
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
base: main
Are you sure you want to change the base?
Conversation
Hello @phepworth, and thank you very much for your first pull request to the Zephyr project! |
@kartben Are you ok with the formatting? |
It's a bit extreme to do both bold and emphasis IMO, so simply bold should be plenty fine :) |
I've found that a lot of fonts render bold with little extra weight making it not really very emphasized, so I went with bold-ital (equivalent, using the semantic tags). But I'm okay going with just bold. So I'll commit the suggested changes. |
fs_open and fs_opendir rely on the structures in the first param being intialized. (The init functions are documented with the type declarations.) This simple documentation change mentions this need to initialize (and emphasizes it). (Users of similar APIs such as POSIX open and opendir do not expect this initialization need.) Fixes zephyrproject-rtos#97205 Signed-off-by: Paul Hepworth <[email protected]>
|
I think it's ok, right? https://builds.zephyrproject.io/zephyr/pr/97291/docs/doxygen/html/group__file__system__api.html#ga00c042be81b3785d868c0c7a680a2fcd |
fs_open and fs_opendir rely on the structures in the first param being intialized. (The init functions are documented with the type declarations.) This simple documentation change mentions this need to initialize (and emphasizes it). (Users of similar APIs such as POSIX open and opendir do not expect this initialization need.)
Fixes #97205