Add documentation for FileService & FileSystemProvider
#8596
Conversation
There was a problem hiding this comment.
@tortmayr thank you for your contribution, please resolve the build errors before we can proceed with a review:
There was a problem hiding this comment.
@tortmayr please be sure to address the build issues (I believe formatting errors), and squash the commits into a single commit with the sign-off. There's no need to co-author me :) all I did was provide a review.
|
Hi @vince-fugnitto thanks for the review! I addressed the remaining issue and squashed the commits. |
| * @param resource `URI` of the resource to test. | ||
| * @param capability The required capability. | ||
| * | ||
| * @returns `true` if the resource can be handled and the required cabability can be provided. |
There was a problem hiding this comment.
| * @returns `true` if the resource can be handled and the required cabability can be provided. | |
| * @returns `true` if the resource can be handled and the required capability can be provided. |
| * @param to `URI` of the target location. | ||
| * @param opts Options to define if existing files should be overwritten. | ||
| */ | ||
|
|
There was a problem hiding this comment.
I believe there is an incorrectly added extra line.
|
|
||
| /** | ||
| * Optional function that has to be implemented by {@link FileSystemProviderWithFileFolderCopyCapability}. | ||
| * see {@link FileSystemProviderWithFileFolderCopyCapability#copy}} for additional documentation. |
There was a problem hiding this comment.
There are extra whitespaces after @link for the following methods.
Please ignore if these are done on purpose.
There was a problem hiding this comment.
I'm pretty sure that's a mistake ;)
fixes eclipse-theia#8599 Contributed on behalf of STMicroelectronics Signed-off-by: Tobias Ortmayr <tortmayr@eclipsesource.com> Signed-off-by: Stefan Dirix <sdirix@eclipsesource.com>
|
Addressed your comments and added some minor additional changes, adjusting whitespace and upper cases in beginning of sentences. |
| * Retrieve the content of a given directory. | ||
| * @param resource The `URI` of the directory. | ||
| * | ||
| * @returns A map containing the {@link FileType} for each child resource (uri). |
There was a problem hiding this comment.
I'll check and come back to you 👍
There was a problem hiding this comment.
Thank you! VS Code uses name. I implemented an FSProvider based on your documentation yesterday, right before I merged it, and readdir did not work.
There was a problem hiding this comment.
I believe you're correct. Debugging into a standard Theia application the existing providers only return file names here, both in browser and in node.
There was a problem hiding this comment.
Thank you so much for checking it. Do you happen to have time to prepare a follow-up PR with the correction?
There was a problem hiding this comment.
PR is here: #8638.
Thanks for noticing this issue!
Fixes #8599
Contributed on behalf of STMicroelectronics
Signed-off-by: Tobias Ortmayr tortmayr@eclipsesource.com
What it does
Add documentation for core components of the
FileService&FileSystemProviderAPIHow to test
Documentation changes only
Review checklist
Reminder for reviewers