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.

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

Documents "No such file or directory" warning when calling disk_*_space functions. #3520

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

timacdonald
Copy link
Contributor

Documenting that both disk_total_space and disk_free_space will trigger a warning when specifying a disk that does not exist.

Screenshot 2024-07-03 at 10 20 27

@timacdonald timacdonald changed the title Disk warning Documents "No such file or directory" warning when calling disk_*_space functions. Jul 3, 2024
Comment on lines +52 to 59
<note>
<para>
When attempting to read a file system or disk partition that does not exist,
an <constant>E_WARNING</constant>-level error message will be issued and
the result will be &false;.
</para>
</note>
</refsect1>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be in a new Error/Exceptions sections to follow the usual manual structure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants