Add explicit package name in demo#18
Merged
sliemeobn merged 2 commits intoFeb 26, 2026
Merged
Conversation
added 2 commits
February 26, 2026 08:14
Without a name the directory name is used as the package name. When downloading the repository directly from GitHub the directory name (and therefore package name) is “elementary-htmx-main”. The incorrect package name causes the demo projects to not build. Adding explicit package names resolves this issue.
When I (as a first time user) were trying to quickly grab the correct imports for elementary-htmx from the demo projects I completely glossed over the local package. Instead I incorrectly guessed that everything would come from the hummingbird-community/hummingbird-elementary package. I think a comment in the demo project would be a nice way to steer tired eyes in the right direction.
Collaborator
|
thanks! lgtm |
This file contains hidden or 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
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 PR contains two commits.
explicit package name added to demo projects
Without a name the directory name is used as the package name. When downloading the repository directly from GitHub the directory name (and therefore package name) is “elementary-htmx-main”. The incorrect package name causes the demo projects to not build.
Adding explicit package names resolves this issue.
added comments for remote dependency to demo
When I (as a first time user) were trying to quickly grab the correct imports for elementary-htmx from the demo projects I completely glossed over the local package. Instead I incorrectly guessed that everything would come from the hummingbird-community/hummingbird-elementary package.
I think a comment in the demo project would be a nice way to steer tired eyes in the right direction.
Discussion
Another way to resolve both issues would be to use a remote dependency in the demo projects instead of the local dependency. I guess a local dependency is used since it makes developing the demo projects in tandem with the elementary-htmx package easier.
I believe either solution is fine and that the issue is not worth giving too much thought :)