Spellcheck and add GitHub Action for repo #23
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
|
See https://github.com/carpentries-incubator/julia-novice/runs/3253449441#check-step-16 for your existing lesson warnings, they are mostly line lengths. |
|
Thats great. Thank you! |
|
@ocaisa unfortunately this workflow is broken now (https://github.com/carpentries-incubator/julia-novice/actions/runs/3575956386) |
|
@BeastyBlacksmith Problem was not really related to this PR, fixed in #38 |
BeastyBlacksmith
added a commit
that referenced
this pull request
Aug 11, 2023
* Initial commit * add topic skeleton * trebuchet-intro + lessons (#4) * trebuchet-intro * variable assignment * add Unicode section * add REPL-modes * type hierarchy * add subtypes example * pkg-activate, add * Update _episodes/04-pkg.md Co-authored-by: Mosè Giordano <[email protected]> * create functions episode * first shot fired * defining functions * keyword question * change feature to control flow * add control flow and anonymous functions * add for and while loops one thing to keep in mind is that this needs FluxML/Trebuchet.jl#10 Co-authored-by: Mosè Giordano <[email protected]> Co-authored-by: Simon Christ <[email protected]> * Update AUTHORS * add metadata and fix solution layouts * add missing class * clearly seperate module and package episode * update tooling (#7) * includes download instructions in setup.md * move module section to correct episode * add section about adding methods * removes output fences * adds section about creating a subtype * adds section about mutability * adds interfaces and empty conditionals * mentions `include` * updates instructor link * add module code * improve type section * add section about imports and conflicts * resolves name conflict in functions.md * update module lesson code, fix interface challange * update gradient section 1 * fix example * update gradient section 2 * add shell mode challange * fix shell mode challenge * Add package episode, finish modules (#11) * finish section about modules * add section about Revise * finish package section * delete 'd' * fix types challenge * fix juliahub link * fix more challenges * missing " * add if/else section * don't use type parameters * add meta information * Update _episodes/07-modules.md Co-authored-by: Mosè Giordano <[email protected]> Co-authored-by: Mosè Giordano <[email protected]> * increase minimum julia * clarified setup.md and requirements (#13) * clarified setup.md and requirements * fix use of prepositions in setup.md * add arrays to requirements * add statement about programming experience * added myself as author (#17) * Update 02-REPL.md (#20) * Update 02-REPL.md Fix Typos Add notes on interactive REPL and shell mode * Update _episodes/02-REPL.md * Update _episodes/02-REPL.md * Update _episodes/02-REPL.md * Update _episodes/02-REPL.md Co-authored-by: Simon Christ <[email protected]> * add picture * add introduction * Add test episode (#21) * add tests file * add test section, package code in code * add test challange * making main image smaller (#22) * making main image smaller * change size of trebuchet Co-authored-by: Simon Christ <[email protected]> * Spellcheck and add GitHub Action for repo (#23) * Spellcheck and add GitHub Action for repo * Add lesson checks * Update lesson.yml * Update after first teaching (#26) * add better setup and run instructions * add information on exiting sticky modes * change type challange to multiple choice * add Pkg.status * mention `varinfo` * add PkgSkeleton * add example directory structure * adjust height of trebuchet * add better setup and run instructions * add information on exiting sticky modes * change type challange to multiple choice * add Pkg.status * mention `varinfo` * add PkgSkeleton * add example directory structure * adjust timings * turn keyword argument challange into multiple choice * improve challenges * add aspekt of composition * add analogy from discourse * declare as alpha (#27) * declare as alpha * Update README.md * fix quote * surface plot (#28) * add function * add figure of distances * Language mechanics (#29) * julia -> Julia, where appropriate * Lesson grammar check; remove HTML tags from MD * wrap markdown at 79 lines; fix VSCode template Very long lines render poorly on GitHub and in editors, and (perhaps more significantly) require larger blobs for git to track changes. This commit wraps lines at 79 chars, for the most part, to improve rendering, readability, and repository size. `.editorconfig` has been updated to reflect the change. In addition, the VSCode template for Challenge-and-Solution blocks was modified to insert blank lines after each title. * tidy up the README * add missing ] * Cosmetics (#31) * provide installation instructions for git-bash and julia * better clarity on input, output, and modes * clarify discussion of types * restore <kbd> tags where they were appropriate * minor tidying of pkg explanation * JH version of Trebuchet lacks shoot, docstrings, use GH instead * clarify some things about functions; revisit mode prompts * clarify control flow some * space things out a little * capitalization * 1e-1 is unintuitive, use 0.1 instead * missing codeblock types * address reviewer comments * add myself as an author * unpack multi-input block, address comments * `print` is superfluous in a REPL Co-authored-by: Simon Christ <[email protected]> Co-authored-by: Simon Christ <[email protected]> * fix missing "s * update hello shell task * clarify default environment prompt in pkg * mention how to get back * add help mode * update installation instructions * fix intro pictures * Update 07-modules.md (#33) Missing "t" results in an error. * fixing branch name typo (#35) * add juliaup instructions * fix #37 * Update action to use main (#38) * Update action to use main * Update lesson.yml Co-authored-by: Simon Christ <[email protected]> * Update lesson.yml * Update lesson.yml (#39) Co-authored-by: Simon Christ <[email protected]> * Replace Nano with Visual Studio Code in setup instructions (#41) * Create install-vscode.html * typing up instructions for windows * changing command line editor to visual studio code * fixing typos, improving command palette step * adding mac and linux instructions * updating intro sentence * typo * nano OR vscode * nano OR vscode * nano OR vscode * add exercise to check subtyping (#48) * add exercise to check subtyping * adding trailing bracket Co-authored-by: Kevin Bonham <[email protected]> * Update _episodes/06-control-flow.md --------- Co-authored-by: Kevin Bonham <[email protected]> Co-authored-by: Simon Christ <[email protected]> * Update setup.md (#51) Added a list of three steps required to complete the setup for this lesson * cleanup * remove leftovers --------- Co-authored-by: Toby Hodges <[email protected]> Co-authored-by: Saranjeet Kaur <[email protected]> Co-authored-by: Mosè Giordano <[email protected]> Co-authored-by: François Michonneau <[email protected]> Co-authored-by: lucaferranti <[email protected]> Co-authored-by: lokamani <[email protected]> Co-authored-by: Sarah Stevens <[email protected]> Co-authored-by: ocaisa <[email protected]> Co-authored-by: Trevor Keller <[email protected]> Co-authored-by: Myrkwid <[email protected]> Co-authored-by: Michael Culshaw-Maurer <[email protected]> Co-authored-by: ocaisa <[email protected]> Co-authored-by: snotskie <[email protected]> Co-authored-by: Peter Steinbach <[email protected]> Co-authored-by: Kevin Bonham <[email protected]> Co-authored-by: Waqquas Bukhsh <[email protected]>
|
@all-contributors add @ocaisa for infra |
|
I've put up a pull request to add @ocaisa! 🎉 |
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.
At the moment your GitHub Action doesn't do anything (it is skipped by default). This version will do a spell check on contributions and also try to build the site. It will also run the lesson checks.
I also fixed the existing spelling typos.