Final run-through

Author: PhilipFackler

README.md

@@ -1,84 +1,9 @@
-# The Carpentries Workbench Template Markdown Lesson
+[![Website](https://github.com/ornl-training/julia-intro/actions/workflows/pages/pages-build-deployment/badge.svg)](https://ornl-training.github.io/julia-intro)
 
-This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. 
+# Beginner Programming in Julia
 
-## Note about lesson life cycle stage
-Although the `config.yaml` states the life cycle stage as pre-alpha, **the template is stable and ready to use**. The life cycle stage is preset to `"pre-alpha"` as this setting is appropriate for new lessons initialised using the template.
+These lessons target people who already have some experience with (scientific)
+programming but are new to Julia.
 
-## Create a new repository from this template
-
-To use this template to start a new lesson repository, 
-make sure you're logged into Github.   
-Visit https://github.com/carpentries/workbench-template-md/generate
-and follow the instructions.
-Checking the 'Include all branches' option will save some time waiting for the first website build
-when your new repository is initialised.
-
-If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges)
-
-## Configure a new lesson
-
-Follow the steps below to
-complete the initial configuration of a new lesson repository built from this template:
-
-1. **Make sure GitHub Pages is activated:**
-   navigate to _Settings_,
-   select _Pages_ from the left sidebar,
-   and make sure that `gh-pages` is selected as the branch to build from.
-   If no `gh-pages` branch is available, check the _Actions_ tab to see if the first
-   website build workflows are still running.
-   If they're not running yet, you may need to manually enable them via the _Actions_ tab.
-   The branch should become available when those have completed.
-1. **Adjust the `config.yaml` file:**
-   this file contains global parameters for your lesson site.
-   Individual fields within the file are documented with comments (beginning with `#`)
-   At minimum, you should adjust all the fields marked 'FIXME':
-   - `title`
-   - `created`
-   - `keywords`
-   - `life_cycle` (the default, _pre-alpha_, is the appropriate for brand new lessons)
-   - `contact`
-1. **Annotate the repository** with site URL and topic tags:
-   navigate back to the repository landing page and
-   click on the gear wheel/cog icon (similar to ⚙️) 
-   at the top-right of the _About_ box.
-   Check the "Use your GitHub Pages website" option,
-   and [add some keywords and other annotations to describe your lesson](https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags)
-   in the _Topics_ field.
-   At minimum, these should include:
-   - `lesson`
-   - the life cycle of the lesson (e.g. `pre-alpha`)
-   - the human language the lesson is written in (e.g. `deutsch`)
-1. **Adjust the 
-   `CITATION.cff`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files**
-   as appropriate for your project.
-   -  `CITATION.cff`:
-      this file contains information that people can use to cite your lesson,
-      for example if they publish their own work based on it.
-      You should [update the CFF][cff-sandpaper-docs] now to include information about your lesson,
-      and remember to return to it periodically, keeping it updated as your
-      author list grows and other details become available or need to change.
-      The [Citation File Format home page][cff-home] gives more information about the format,
-      and the [`cffinit` webtool][cffinit] can be used to create new and update existing CFF files.
-   -  `CODE_OF_CONDUCT.md`: 
-      if you are using this template for a project outside The Carpentries,
-      you should adjust this file to describe 
-      who should be contacted with Code of Conduct reports,
-      and how those reports will be handled.
-   -  `CONTRIBUTING.md`:
-      depending on the current state and maturity of your project,
-      the contents of the template Contributing Guide may not be appropriate.
-      You should adjust the file to help guide contributors on how best
-      to get involved and make an impact on your lesson.
-   -  `LICENSE.md`:
-      in line with the terms of the CC-BY license,
-      you should ensure that the copyright information 
-      provided in the license file is accurate for your project.
-1. **Update this README with 
-   [relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)**
-   and delete this section.
-
-[cff-home]: https://citation-file-format.github.io/
-[cff-sandpaper-docs]:  https://carpentries.github.io/sandpaper-docs/editing.html#making-your-lesson-citable
-[cffinit]: https://citation-file-format.github.io/cff-initializer-javascript/
-[workbench]: https://carpentries.github.io/sandpaper-docs/
+These are largely based on the lessons
+[here](https://github.com/carpentries-incubator/julia-novice).

config.yaml

@@ -28,7 +28,7 @@ keywords: 'julia, programming, software'
 
 # Life cycle stage of the lesson
 # possible values: pre-alpha, alpha, beta, stable
-life_cycle: 'pre-alpha' # FIXME
+life_cycle: 'alpha' # FIXME
 
 # License of the lesson
 license: 'CC-BY 4.0'

episodes/01_04_Using_the_package_manager.md

@@ -163,7 +163,7 @@ environments.  That is useful for development time convenience packages like
 Melissa now returns to her project environment.
 
 ```julia
-(trebuchet) pkg> activate projects/trebuchet
+(@v1.11) pkg> activate projects/trebuchet
 ```
 
 ## Using and importing packages

episodes/02_01_Functions.md

@@ -86,7 +86,7 @@ those that are not exported. What would the function call look like?
  2. `names(Trebuchets, all = true)` <!---correct-->
  3. `names(Trebuchets, all)`
  4. `names(Trebuchets; all = true)` <!---correct-->
- 5. Answer 2 and 4 <!---correct-->
+ 5. Both 2 and 4 <!---correct-->
 
 :::::: solution
 
@@ -220,7 +220,7 @@ Trebuchets.shoot(5, 0.25pi, 500)[2]
 114.88494815382731
 ```
 
-which means the shot traveled approximately 118 m.
+which means the shot traveled approximately 115 m.
 
 ### Defining functions
 
@@ -423,7 +423,7 @@ She can also lookup the docstring using the `@doc` macro
   See also: length, ndims, eachindex, sizeof.
 
   Examples
-  ≡≡≡≡≡≡≡≡≡≡
+  ≡≡≡≡≡≡≡≡
 
   julia> A = fill(1, (2,3,4));
   
@@ -437,25 +437,6 @@ She can also lookup the docstring using the `@doc` macro
 
   Return a tuple with the size of the buffer.
 
-  size(g, i)
-
-  Return the number of vertices in g if i=1 or i=2, or 1 otherwise.
-
-  Examples
-  ≡≡≡≡≡≡≡≡≡≡
-
-  julia> using Graphs
-  
-  julia> g = cycle_graph(4);
-  
-  julia> size(g, 1)
-  4
-  
-  julia> size(g, 2)
-  4
-  
-  julia> size(g, 3)
-  1
 ```
 
 With that information she can now implement this method:
@@ -508,7 +489,7 @@ She looks up the documentation for that function
   syntax Type[]. Element values can be specified using Type[a,b,c,...].
 
   Examples
-  ≡≡≡≡≡≡≡≡≡≡
+  ≡≡≡≡≡≡≡≡
 
   julia> Int8[1, 2, 3]
   3-element Vector{Int8}:
@@ -525,13 +506,12 @@ She looks up the documentation for that function
   getindex(collection, key...)
 
   Retrieve the value(s) stored at the given key or index within a collection.
-  The syntax a[i,j,...] is converted by the compiler to getindex(a, i, j,
-  ...).
+  The syntax a[i,j,...] is converted by the compiler to getindex(a, i, j, ...).
 
   See also get, keys, eachindex.
 
   Examples
-  ≡≡≡≡≡≡≡≡≡≡
+  ≡≡≡≡≡≡≡≡
 
   julia> A = Dict("a" => 1, "b" => 2)
   Dict{String, Int64} with 2 entries:
@@ -543,12 +523,21 @@ She looks up the documentation for that function
 
   getindex(A, inds...)
 
-  Return a subset of array A as specified by inds, where each ind may be, for
-  example, an Int, an AbstractRange, or a Vector. See the manual section on
-  array indexing for details.
+  Return a subset of array A as selected by the indices inds.
+
+  Each index may be any supported index type, such as an Integer,
+  CartesianIndex, range, or array of supported indices. A : may be used to
+  select all elements along a specific dimension, and a boolean array (e.g. an
+  Array{Bool} or a BitArray) may be used to filter for elements where the
+  corresponding index is true.
+
+  When inds selects multiple elements, this function returns a newly allocated
+  array. To index multiple elements without making a copy, use view instead.
+
+  See the manual section on array indexing for details.
 
   Examples
-  ≡≡≡≡≡≡≡≡≡≡
+  ≡≡≡≡≡≡≡≡
 
   julia> A = [1 2; 3 4]
   2×2 Matrix{Int64}:
@@ -568,14 +557,35 @@ She looks up the documentation for that function
    3
    2
    4
+  
+  julia> getindex(A, 2, 1)
+  3
+  
+  julia> getindex(A, CartesianIndex(2, 1))
+  3
+  
+  julia> getindex(A, :, 2)
+  2-element Vector{Int64}:
+   2
+   4
+  
+  julia> getindex(A, 2, :)
+  2-element Vector{Int64}:
+   3
+   4
+  
+  julia> getindex(A, A .> 2)
+  2-element Vector{Int64}:
+   3
+   4
 
   getindex(tree::GitTree, target::AbstractString) -> GitObject
 
-  Look up target path in the tree, returning a GitObject (a GitBlob in the
-  case of a file, or another GitTree if looking up a directory).
+  Look up target path in the tree, returning a GitObject (a GitBlob in the case
+  of a file, or another GitTree if looking up a directory).
 
   Examples
-  ≡≡≡≡≡≡≡≡≡≡
+  ≡≡≡≡≡≡≡≡
 
   tree = LibGit2.GitTree(repo, "HEAD^{tree}")
   readme = tree["README.md"]
@@ -594,13 +604,21 @@ She looks up the documentation for that function
 
   Returns a vector with all elements of array partition A.
 
+  getindex(
+      c::SciMLBase.AbstractClock,
+      idx
+  ) -> SciMLBase.IndexedClock
+  
+
+  Return a SciMLBase.IndexedClock representing the subset of the time points
+  that the clock ticked indicated by idx.
+
   v = sd[k]
 
   Argument sd is a SortedDict and k is a key. In an expression, this retrieves
-  the value (v) associated with the key (or KeyError if none). On the
-  left-hand side of an assignment, this assigns or reassigns the value
-  associated with the key. (For assigning and reassigning, see also insert!
-  below.) Time: O(c log n)
+  the value (v) associated with the key (or KeyError if none). On the left-hand
+  side of an assignment, this assigns or reassigns the value associated with the
+  key. (For assigning and reassigning, see also insert! below.) Time: O(c log n)
 
   cb[i]
 
@@ -612,13 +630,9 @@ She looks up the documentation for that function
 
   getindex(tree, ind)
 
-  Gets the key present at index ind of the tree. Indexing is done in
-  increasing order of key.
-
-  g[iter]
+  Gets the key present at index ind of the tree. Indexing is done in increasing
+  order of key.
 
-  Return the subgraph induced by iter. Equivalent to induced_subgraph(g,
-  iter)[1].
 ```
 
 Note that the documentation for all methods gets shown and Melissa needs to look