fix(docs): some typos in website and nodejs binding docs #4814
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: suyanhanx <suyanhanx@gmail.com>
Xuanwo
reviewed
Jun 26, 2024
| @@ -36,7 +36,10 @@ pub struct Operator(opendal::Operator); | |||
| #[napi] | |||
| impl Operator { | |||
| #[napi(constructor)] | |||
| /// @see For a detailed definition of scheme, see https://opendal.apache.org/docs/category/services | |||
| /// @see For the full list of scheme, see https://docs.rs/opendal/latest/opendal/services/index.html | |||
There was a problem hiding this comment.
Please add comments before #[napi(constructor)].
And I want to avoid redirecting nodejs users to docs.rs. Maybe we can give a simple list of possible services based on enabled services?
There was a problem hiding this comment.
Maybe we can give a simple list of possible services based on enabled services?
It's a more generic need. We can deal with it in a slightly more uniform way.
There was a problem hiding this comment.
We may create an issue to track this.
I won't fix this in this PR.
|
Hi, please take a look over the failed CI: https://github.com/apache/opendal/actions/runs/9682600058/job/26715994968?pr=4814 |
Signed-off-by: suyanhanx <suyanhanx@gmail.com>
PsiACE
approved these changes
Jun 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bumped napi-cli to clean the following warning.
