Tweaks to inspect accelerator tutorial - #53
Merged
GamelinAl merged 2 commits intoOct 5, 2026
Merged
Conversation
Member
|
I agree with you, this tutorial is not very good anyway. I'll make a better one once the ElementHolder PR has been merged. Let's merge this for now. |
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.
I only made some tiny changes. The rest looked better than before to me.
But reading this tutorial made me confused about the responsibility of the yellow pages vs the responsibility of the element holders. You can also get elements through the yellow pages so there is even more APIs available for the users?
I think this is confusing rather than helpful:
Having several ways to achieve the same thing I think makes it difficult for new users. Fewer options are easier to learn. So either maybe we should hide this functionality from the tutorials or we should try to align the APIs in a way that makes it easier to understand the two options? For example if the tutorial had said:
where the first is the API for the yellow pages and the second for the element holder it would have made sense to me. But at the moment I don't understand how the user from looking at the yellow pages will understand that there is also the option to do
accelerator.design.magnets.get("QForTune")since it doesn't list anything calledmagnets. But aligning the APIs for these two is perhaps part of the work with the modifications to the element holder?