Rename package

PdIPS · Nov 18, 2023 · 8a745c0 · 8a745c0
1 parent 15fc08f
commit 8a745c0
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 37 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -63,6 +63,6 @@ jobs:
       - run: |
           julia --project=docs -e '
             using Documenter: DocMeta, doctest
-            using Default
-            DocMeta.setdocmeta!(Default, :DocTestSetup, :(using Default); recursive=true)
-            doctest(Default)'
+            using DefaultKeywordArguments
+            DocMeta.setdocmeta!(DefaultKeywordArguments, :DocTestSetup, :(using DefaultKeywordArguments); recursive=true)
+            doctest(DefaultKeywordArguments)'
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
-name = "Default"
+name = "DefaultKeywordArguments"
 uuid = "d739bc73-037a-4484-8212-e0e00e9ea6bf"
 authors = ["Dr Rafael Bailo"]
-version = "1.0.0"
+version = "1.1.0"
 
 [compat]
 julia = "1.9"

diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-# Default.jl
+# DefaultKeywordArguments.jl
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://PdIPS.github.io/Default.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://PdIPS.github.io/Default.jl/dev/)
-[![Build Status](https://github.com/PdIPS/Default.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/PdIPS/Default.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/PdIPS/Default.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/PdIPS/Default.jl)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://PdIPS.github.io/DefaultKeywordArguments.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://PdIPS.github.io/DefaultKeywordArguments.jl/dev/)
+[![Build Status](https://github.com/PdIPS/DefaultKeywordArguments.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/PdIPS/DefaultKeywordArguments.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/PdIPS/DefaultKeywordArguments.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/PdIPS/DefaultKeywordArguments.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**Default.jl** is a package to handle *default keyword arguments* in Julia. It has been developed to support [CBX.jl](https://github.com/PdIPS/CBX.jl).
+**DefaultKeywordArguments.jl** is a package to handle *default keyword arguments* in Julia. It has been developed to support [CBX.jl](https://github.com/PdIPS/CBX.jl).
 
 ## The `@default` Macro
 

diff --git a/citation.cff b/citation.cff
@@ -1,10 +1,10 @@
 cff-version: 1.2.0
-title: 'Default.jl'
+title: 'DefaultKeywordArguments.jl'
 message: 'If you use this software, please cite it as below.'
 authors:
   - family-names: 'Bailo'
     given-names: 'Rafael'
     orcid: 'https://orcid.org/0000-0001-8018-3799'
 type: software
-version: 1.0.0
-url: 'https://github.com/PdIPS/Default.jl'
+version: 1.1.0
+url: 'https://github.com/PdIPS/DefaultKeywordArguments.jl'
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,3 @@
 [deps]
-Default = "d739bc73-037a-4484-8212-e0e00e9ea6bf"
+DefaultKeywordArguments = "d739bc73-037a-4484-8212-e0e00e9ea6bf"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,22 +1,30 @@
 push!(LOAD_PATH, "../src/")
 
-using Default
+using DefaultKeywordArguments
 using Documenter
 
-DocMeta.setdocmeta!(Default, :DocTestSetup, :(using Default); recursive = true)
+DocMeta.setdocmeta!(
+  DefaultKeywordArguments,
+  :DocTestSetup,
+  :(using DefaultKeywordArguments);
+  recursive = true,
+)
 
 makedocs(;
-  modules = [Default],
+  modules = [DefaultKeywordArguments],
   authors = "Dr Rafael Bailo",
-  repo = "https://github.com/PdIPS/Default.jl/blob/{commit}{path}#{line}",
-  sitename = "Default.jl",
+  repo = "https://github.com/PdIPS/DefaultKeywordArguments.jl/blob/{commit}{path}#{line}",
+  sitename = "DefaultKeywordArguments.jl",
   format = Documenter.HTML(;
     prettyurls = get(ENV, "CI", "false") == "true",
-    canonical = "https://PdIPS.github.io/Default.jl",
+    canonical = "https://PdIPS.github.io/DefaultKeywordArguments.jl",
     edit_link = "main",
     assets = String[],
   ),
   pages = ["Home" => "index.md"],
 )
 
-deploydocs(; repo = "github.com/PdIPS/Default.jl", devbranch = "main")
+deploydocs(;
+  repo = "github.com/PdIPS/DefaultKeywordArguments.jl",
+  devbranch = "main",
+)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,17 +1,17 @@
 ```@meta
-CurrentModule = Default
+CurrentModule = DefaultKeywordArguments
 ```
 
-# Default.jl
+# DefaultKeywordArguments.jl
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://PdIPS.github.io/Default.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://PdIPS.github.io/Default.jl/dev/)
-[![Build Status](https://github.com/PdIPS/Default.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/PdIPS/Default.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/PdIPS/Default.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/PdIPS/Default.jl)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://PdIPS.github.io/DefaultKeywordArguments.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://PdIPS.github.io/DefaultKeywordArguments.jl/dev/)
+[![Build Status](https://github.com/PdIPS/DefaultKeywordArguments.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/PdIPS/DefaultKeywordArguments.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/PdIPS/DefaultKeywordArguments.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/PdIPS/DefaultKeywordArguments.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**Default.jl** is a package to handle *default keyword arguments* in Julia. It has been developed to support [CBX.jl](https://github.com/PdIPS/CBX.jl).
+**DefaultKeywordArguments.jl** is a package to handle *default keyword arguments* in Julia. It has been developed to support [CBX.jl](https://github.com/PdIPS/CBX.jl).
 
 ## The `@default` Macro
 
@@ -130,5 +130,5 @@ Once again, you are allowed to have extra arguments, type annotations, or defaul
 ```
 
 ```@autodocs
-Modules = [Default]
+Modules = [DefaultKeywordArguments]
 ```
diff --git a/src/Default.jl → src/DefaultKeywordArguments.jl b/src/Default.jl → src/DefaultKeywordArguments.jl
@@ -1,4 +1,4 @@
-module Default
+module DefaultKeywordArguments
 
 """
 ```

diff --git a/test/@config.jl b/test/@config.jl
@@ -1,4 +1,4 @@
-using Default, Test
+using DefaultKeywordArguments, Test
 
 const default_config = (; a = 1, b = 1.0, c = 1 // 1)
 

diff --git a/test/@default.jl b/test/@default.jl
@@ -1,4 +1,4 @@
-using Default, Test
+using DefaultKeywordArguments, Test
 
 const default_values = (; a = 1, b = 1.0, c = 1 // 1)
 

diff --git a/test/aqua.jl b/test/aqua.jl
@@ -1,3 +1,3 @@
-using Aqua, Default
+using Aqua, DefaultKeywordArguments
 
-Aqua.test_all(Default, deps_compat = false)
+Aqua.test_all(DefaultKeywordArguments, deps_compat = false)
diff --git a/test/format.jl b/test/format.jl
@@ -1,4 +1,4 @@
-using Default, JuliaFormatter, Test
+using DefaultKeywordArguments, JuliaFormatter, Test
 
 function tests()
   function f(s)

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,6 +1,6 @@
 using Test, SafeTestsets
 
-@testset "Default.jl" begin
+@testset "DefaultKeywordArguments.jl" begin
   for test ∈ ["@config", "@default", "aqua", "format"]
     @eval begin
       @safetestset $test begin