Improve Module API docs & example #26637
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
Signed-off-by: Michael Telatynski <[email protected]>
Johennes
reviewed
Nov 24, 2023
| # An example of pulling a module from github | ||
| - "github:vector-im/element-web-ilag-module#main" | ||
| # An example of pulling a module from local filesystem during development | ||
| - "file:/home/user/development/element-web-ilag-module" |
There was a problem hiding this comment.
Do we need to mention here that you'll have to build it yourself in the folder?
There was a problem hiding this comment.
That depends on your module though, if your module is JS then you don't need to build, nowhere do we state that we build your module for any dependency type, when installing an npm dependency it may or may not be built depending on what the lifecycle scripts do. So this could cause more confusion than good IMO
weeman1337
approved these changes
Nov 28, 2023
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.
This change is marked as an internal change (Task), so will not be included in the changelog.