Add documentation options for extension!() #232
Merged
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
fix: fix op_format_file_name op reference (#230)
Merge changes
|
|
rscarson
changed the title
mmastrac
reviewed
Sep 23, 2023
Co-authored-by: Matt Mastracci <matthew@mastracci.com>
mmastrac
reviewed
Sep 25, 2023
mmastrac
reviewed
Sep 25, 2023
Co-authored-by: Matt Mastracci <matthew@mastracci.com>
Co-authored-by: Matt Mastracci <matthew@mastracci.com>
nayeemrmn
reviewed
Sep 26, 2023
core/extensions.rs
Outdated
Comment on lines
376
to
381
| /// Initialize this extension for use with CommonJS | ||
| /// For modules, use init_ops_and_esm instead | ||
| /// | ||
| /// # Returns | ||
| /// an Extension object that can be used during instantiation of a JsRuntime | ||
| pub fn init_js_only $( < $( $param : $type + 'static ),* > )? () -> $crate::Extension |
There was a problem hiding this comment.
I think we should leave this one undocumented, or even mark it as deprecated. We don't use it in CLI or anywhere I know of. And I don't know when you'd use it. It might be a legacy thing. It seems to just not execute the state fn and middleware.
There was a problem hiding this comment.
/// Legacy function for extension instantiation.
/// Please use `init_ops_and_esm` or `init_ops` instead
///
/// # Returns
/// an Extension object that can be used during instantiation of a JsRuntime
#[deprecated(since="0.216.0", note="please use `init_ops_and_esm` or `init_ops` instead")]Added deprecation notice, and altered documentation to reflect the change
nayeemrmn
reviewed
Sep 26, 2023
nayeemrmn
reviewed
Sep 26, 2023
Co-authored-by: Nayeem Rahman <nayeemrmn99@gmail.com>
Co-authored-by: Nayeem Rahman <nayeemrmn99@gmail.com>
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.
Added
docs: comma separated list of toplevel #[doc=...] tags to be applied to the extension's resulting structto extension! to allow users to set docblocks for it, since the struct is always made publicAdded comments for generated functions, since they break linting when warning about missing function docs
Added an op2 example that uses the change (also it is difficult to find samples of op2 and extension! in use with the runtime - having access to such an example would have simplified my usage of the crate significantly