Skip to content

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 8, 2024

Previously the documentation comment claimed the function had a dirname parameter even though the function does not have any parameters.

This only fixes the comment, leaving the incorrect information in the API docs:

### `remove` <a id="class_folder_1aca893daac6c6747895d50987cf9cf34c" class="anchor"></a>
```cpp
public bool remove()
```
Removes a directory.
#### Parameters
* `dirname` The name of the directory to remove.

That should be resolved by regenerating the documentation from the source code.


Originally reported at f77f873#r145141720

Previously the documentation comment claimed the function had a `dirname` parameter even though the function does not have any parameters.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Aug 8, 2024
@per1234 per1234 requested a review from sebromero August 8, 2024 01:23
per1234 referenced this pull request Aug 8, 2024
@sebromero sebromero merged commit da04587 into arduino-libraries:main Aug 19, 2024
3 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants