Skip to content

Commit

Permalink
merge
Browse files Browse the repository at this point in the history
  • Loading branch information
eford committed Sep 18, 2024
2 parents 3a6d38b + 4b29a2c commit 5ace09b
Show file tree
Hide file tree
Showing 25 changed files with 1,906 additions and 959 deletions.
1 change: 1 addition & 0 deletions .JuliaFormatter.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
style = "blue"
44 changes: 44 additions & 0 deletions .github/workflows/Test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Julia tests

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the main branch
# this is the same as Test.yml
on:
workflow_dispatch:
push:
paths-ignore:
- '**.md'
branches:
- main
pull_request:
paths-ignore:
- '**.md'


# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
test:
runs-on: ${{ matrix.os }}
timeout-minutes: 10

strategy:
# Without setting this, a failing test cancels all others
fail-fast: false
matrix:
julia-version: ["1.6", "1", "~1.10.0-0"]
os: [ubuntu-latest]

steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

# Makes the `julia` command available
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.julia-version }}
- uses: julia-actions/cache@v1

# 🚗
- uses: julia-actions/julia-runtest@v1
with:
coverage: false
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/Manifest.toml
/test/Manifest.toml
data
17 changes: 5 additions & 12 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,28 +1,21 @@
name = "PlutoTeachingTools"
uuid = "661c6b06-c737-4d37-b85c-46df65de6f69"
authors = ["Eric Ford <[email protected]> and contributors"]
version = "0.2.11"
version = "0.3.0"

[deps]
Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
HypertextLiteral = "ac1192a8-f4b3-4bfe-ba22-af5b92cd3ab2"
LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
PlutoLinks = "0ff47ea0-7a50-410d-8455-4348d5de0420"
PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

[compat]
Downloads = "<0.0.1, 1"
HypertextLiteral = "0.9"
LaTeXStrings = "1"
Latexify = "0.15"
Latexify = "0.15, 0.16"
Markdown = "<0.0.1, 1"
PlutoLinks = "0.1.5"
PlutoUI = "0.7"
julia = "1.7, 1.8"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Test"]
julia = "1.6"
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# PlutoTeachingTools

This package provides several functions that are useful in Pluto notebooks used for teaching and making tutorials. The inital version merely borrowed functions from modules and/or homeworks from the excellent MIT course, [Introduction to Computational Thinking
Math from computation, math with computation (Spring 2021)](https://computationalthinking.mit.edu/Spring21/). Since there, there have been several additions from various other packages and issues.
This package provides several functions that are useful in Pluto notebooks used for teaching and making tutorials. The initial version merely borrowed functions from modules and/or homeworks from the excellent MIT course, [Introduction to Computational Thinking
Math from computation, math with computation (Spring 2021)](https://computationalthinking.mit.edu/Spring21/). Since then, there have been several additions from various other packages and issues.

See the **[example notebook](https://juliapluto.github.io/PlutoTeachingTools.jl/example.html)** for functions provided.
Several functions have optional arguements that aren't (yet?) demonstrated in the example notebook.
Several functions have optional arguments that aren't (yet?) demonstrated in the example notebook.

I encourage others to improve and/or contribute new functions that are of value to other educators. PRs welcome. (Breaking PRs will usualy be delayed until the end of the academic semester for the maintainer.)
I encourage others to improve and/or contribute new functions that are of value to other educators. Pull Requests welcome. (Breaking PRs will usually be delayed until the end of the academic semester for the maintainer.)

# Courses/Sites using PlutoTeachingTools
- [Astroinformatics Summer School (2022)](https://github.com/Astroinformatics/SummerSchool2022)
Expand Down
12 changes: 6 additions & 6 deletions demo_module.jl
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
module Demo
export hello, hundred

function hello()
return "Hello!"
end

hundred = 100
export hello, hundred

function hello()
return "Hello!"
end

hundred = 100

end # module
15 changes: 0 additions & 15 deletions example.html

This file was deleted.

Loading

2 comments on commit 5ace09b

@eford
Copy link
Collaborator Author

@eford eford commented on 5ace09b Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release Notes:

  • Add Chinese and Russian
  • Improve CI testing (JuliaFormatter, Aqua, JET)
  • Cleanup of dependencies and compat
  • Code formatting cleanup
  • Fixed some typeo/bugs

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/115389

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 5ace09bb86d8d9f341229c6a5a5768f674df3412
git push origin v0.3.0

Please sign in to comment.