Updates to getting-started documentation and coffee-machine tutorial #3241
Conversation
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
the built app crashes on startup if this command was not run before. the locale folder is empty by default.
preconfigure the repo for in-project virtualenv
since IDs are not used and implemented inconsistently, I consider it better to leave them out
to prevent distraction I consider it better to introduce all requirements as 'shall', since all these requirements are verifiable
small suggested improvements encountered during my run through the tutorial
ruff added (with newer version than hook) to dev, and fixed settings to resolve warnings
danyeaw
reviewed
Apr 7, 2024
There was a problem hiding this comment.
Hi @teunhoevenaars, thank you so much for this contribution, these are some really nice documentation updates 🤩.
I have a few comments about some of the dependencies changed and config files.
danyeaw
approved these changes
Apr 8, 2024
There was a problem hiding this comment.
Thanks again @teunhoevenaars! This is a really great contribution!
| @@ -197,9 +197,6 @@ gettext-mo-release = { "script" = "po.build-babel:compile_mo_release" } | |||
| translations = ["gettext-pot", "gettext-po", "gettext-mo-all"] | |||
| icons = { "shell" = "make -C gaphor/ui/icons" } | |||
|
|
|||
| [tool.poe.executor] | |||
| type = "virtualenv" | |||
|
|
|||
There was a problem hiding this comment.
Nice one, it looks like this puts the configuration back to auto which should allow for centralized virtual environments 👍
|
@all-contributors please add @teunhoevenaars for docs |
|
I've put up a pull request to add @teunhoevenaars! 🎉 |
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.
Small updates and suggestions to clarify issues encountered during the getting-started and coffee-machine tutorial.
PR Checklist
Please check if your PR fulfills the following requirements:
NB the link PR Review Checklist on Contributor guide is broken. Something for a later fix as I'm not sure where it is supposed to reference to.
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
This is my first PR to this project, and have done my best to follow all guidelines. In case I've missed some, then this is absolutely not intentional. Please feel free to revert any changes that you deem inappropriate. Many thanks for all your efforts!