Skip to content

docs(node/Folder): update public interface docs#61572

Open
joshtrichards wants to merge 1 commit into
masterfrom
jtr/docs-nodeFolder-interface
Open

docs(node/Folder): update public interface docs#61572
joshtrichards wants to merge 1 commit into
masterfrom
jtr/docs-nodeFolder-interface

Conversation

@joshtrichards

Copy link
Copy Markdown
Member

Summary

Update public interface docs for OCP\Files\Folder to improve coverage, accuracy and clarity:

  • how search() handles its two accepted query parameter forms
  • tune the base descriptions getById() and getFirstNodeById() to more clearly separate and tidy overall descriptions
  • slightly more specific description for getNonExistingName()
  • add missing description for getRecent() including important details about non-empty folders and 2 week cut-off
  • slightly more specific description for verifyPath()
  • miscellaneous minor clarity/consistency improvements throughout
  • drop unnecessary OCP class boilerplate

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Signed-off-by: Josh <josh.t.richards@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant