build based on 2872688

dev/developers/Manifest.toml

@@ -83,7 +83,7 @@ version = "1.6.0"
 
 [[deps.EasyJobs]]
 deps = ["EasyJobsBase", "Query", "Reexport", "Thinkers", "UUIDs"]
-git-tree-sha1 = "daba64b3f2a0b8346ab61872b4f7e6768c9f0032"
+git-tree-sha1 = "09225892ac2ac0423732acaf60a45e4c722a5a95"
 repo-rev = "main"
 repo-url = "https://github.com/MineralsCloud/EasyJobs.jl"
 uuid = "66d786ec-6e9c-4d5d-a8f6-aa4f8d7350fb"

dev/developers/contributing/index.html

@@ -16,7 +16,7 @@
     Updating `~/work/EasyJobs.jl/EasyJobs.jl/docs/Manifest.toml`
   [66d786ec] ~ EasyJobs v0.9.1 `~/work/EasyJobs.jl/EasyJobs.jl` ⇒ v0.9.1 `~/.julia/dev/EasyJobs`</code></pre><p>Then the package will be cloned to your local machine. On *nix systems, the default path is <code>~/.julia/dev/EasyJobs</code> unless you modify the <a href="http://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_DEPOT_PATH-1"><code>JULIA_DEPOT_PATH</code></a> environment variable. If you&#39;re on Windows, this will be <code>C:\\Users\\&lt;my_name&gt;\\.julia\\dev\\EasyJobs</code>. In the following text, we will call it <code>PKGROOT</code>.</p><p>Go to <code>PKGROOT</code>, start a new Julia session and run</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.instantiate()</code><code class="nohighlight hljs ansi" style="display:block;">Precompiling project...
 <span class="sgr33">  ✓ </span>EasyJobs
-  1 dependency successfully precompiled in 1 seconds. 34 already precompiled.
+  1 dependency successfully precompiled in 2 seconds. 34 already precompiled.
   <span class="sgr33">1</span> dependency precompiled but a different version is currently loaded. Restart julia to access the new version</code></pre><p>to instantiate the project.</p><h3 id="Step-4:-checkout-a-new-branch"><a class="docs-heading-anchor" href="#Step-4:-checkout-a-new-branch">Step 4: checkout a new branch</a><a id="Step-4:-checkout-a-new-branch-1"></a><a class="docs-heading-anchor-permalink" href="#Step-4:-checkout-a-new-branch" title="Permalink"></a></h3><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>In the following, replace any instance of <code>GITHUB_ACCOUNT</code> with your GitHub username.</p></div></div><p>The next step is to checkout a development branch. In a terminal (or command prompt on Windows), run:</p><pre><code class="language-shell hljs">cd ~/.julia/dev/EasyJobs
 
 git remote add GITHUB_ACCOUNT https://github.com/GITHUB_ACCOUNT/EasyJobs.jl.git
@@ -35,4 +35,4 @@
 
 git checkout main
 
-git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request! It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div><p>Thanks for contributing to EasyJobs!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../public/">« Public API</a><a class="docs-footer-nextpage" href="../style-guide/">Style Guide »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 1 August 2023 17:58">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request! It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div><p>Thanks for contributing to EasyJobs!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../public/">« Public API</a><a class="docs-footer-nextpage" href="../style-guide/">Style Guide »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 1 August 2023 20:58">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/developers/style-guide/index.html

@@ -2,11 +2,11 @@
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Style Guide · EasyJobs.jl</title><script data-outdated-warner src="../../assets/warner.js"></script><link rel="canonical" href="https://MineralsCloud.github.io/EasyJobs.jl/developers/style-guide/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">EasyJobs.jl</a></span></div><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../../installation/">Installation guide</a></li></ul></li><li><a class="tocitem" href="../../public/">Public API</a></li><li><span class="tocitem">Developer Docs</span><ul><li><a class="tocitem" href="../contributing/">Contributing</a></li><li class="is-active"><a class="tocitem" href>Style Guide</a><ul class="internal"><li><a class="tocitem" href="#Formatting"><span>Formatting</span></a></li></ul></li><li><a class="tocitem" href="../design-principles/">Design Principles</a></li></ul></li><li><a class="tocitem" href="../../troubleshooting/">Troubleshooting</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Developer Docs</a></li><li class="is-active"><a href>Style Guide</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Style Guide</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MineralsCloud/EasyJobs.jl/blob/main/docs/src/developers/style-guide.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="style"><a class="docs-heading-anchor" href="#style">Style Guide</a><a id="style-1"></a><a class="docs-heading-anchor-permalink" href="#style" title="Permalink"></a></h1><ul></ul><p>This section describes the coding style rules that apply to our code and that we recommend you to use it also.</p><p>In some cases, our style guide diverges from Julia&#39;s official <a href="https://docs.julialang.org/en/v1/manual/style-guide/">Style Guide</a> (Please read it!). All such cases will be explicitly noted and justified.</p><p>Our style guide adopts many recommendations from the <a href="https://github.com/invenia/BlueStyle">BlueStyle</a>. Please read the <a href="https://github.com/invenia/BlueStyle">BlueStyle</a> before contributing to this package. If not following, your pull requests may not be accepted.</p><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>The style guide is always a work in progress, and not all EasyJobs code follows the rules. When modifying EasyJobs, please fix the style violations of the surrounding code (i.e., leave the code tidier than when you started). If large changes are needed, consider separating them into another pull request.</p></div></div><h2 id="Formatting"><a class="docs-heading-anchor" href="#Formatting">Formatting</a><a id="Formatting-1"></a><a class="docs-heading-anchor-permalink" href="#Formatting" title="Permalink"></a></h2><h3 id="formatter"><a class="docs-heading-anchor" href="#formatter">Run JuliaFormatter</a><a id="formatter-1"></a><a class="docs-heading-anchor-permalink" href="#formatter" title="Permalink"></a></h3><p>EasyJobs uses <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> as an auto-formatting tool.</p><p>We use the options contained in <a href="https://github.com/MineralsCloud/EasyJobs.jl/blob/main/.JuliaFormatter.toml"><code>.JuliaFormatter.toml</code></a>.</p><p>To format your code, <code>cd</code> to the EasyJobs directory, then run:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.add(&quot;JuliaFormatter&quot;)</code><code class="nohighlight hljs ansi" style="display:block;">   Resolving package versions...
    Installed Glob ─────────── v1.3.1
    Installed Crayons ──────── v4.1.1
+   Installed CSTParser ────── v3.3.6
    Installed Tokenize ─────── v0.5.25
    Installed URIs ─────────── v1.4.2
    Installed CommonMark ───── v0.8.12
    Installed JuliaFormatter ─ v1.0.34
-   Installed CSTParser ────── v3.3.6
     Updating `~/work/EasyJobs.jl/EasyJobs.jl/docs/build/developers/Project.toml`
   [98e50ef6] + JuliaFormatter v1.0.34
     Updating `~/work/EasyJobs.jl/EasyJobs.jl/docs/build/developers/Manifest.toml`
@@ -64,4 +64,4 @@
 <span class="sgr32">  ✓ </span><span class="sgr90">CommonMark</span>
 <span class="sgr32">  ✓ </span><span class="sgr90">CSTParser</span>
 <span class="sgr32">  ✓ </span>JuliaFormatter
-  7 dependencies successfully precompiled in 45 seconds. 10 already precompiled.</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; using JuliaFormatter: format</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; format(&quot;docs&quot;);</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: IOError: realpath(&quot;docs&quot;): no such file or directory (ENOENT)</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; format(&quot;src&quot;);</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: IOError: realpath(&quot;src&quot;): no such file or directory (ENOENT)</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; format(&quot;test&quot;);</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: IOError: realpath(&quot;test&quot;): no such file or directory (ENOENT)</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>A continuous integration check verifies that all PRs made to EasyJobs have passed the formatter.</p></div></div><p>The following sections outline extra style guide points that are not fixed automatically by JuliaFormatter.</p><h3 id="Use-the-Julia-extension-for-Visual-Studio-Code"><a class="docs-heading-anchor" href="#Use-the-Julia-extension-for-Visual-Studio-Code">Use the Julia extension for Visual Studio Code</a><a id="Use-the-Julia-extension-for-Visual-Studio-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Use-the-Julia-extension-for-Visual-Studio-Code" title="Permalink"></a></h3><p>Please use <a href="https://code.visualstudio.com/">VS Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=julialang.language-julia">Julia extension</a> to edit, format, and test your code. We do not recommend using other editors to edit your code for the time being.</p><p>This extension already has <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> integrated. So to format your code, follow the steps listed <a href="https://www.julia-vscode.org/docs/stable/userguide/formatter/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../design-principles/">Design Principles »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 1 August 2023 17:58">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  7 dependencies successfully precompiled in 47 seconds. 10 already precompiled.</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; using JuliaFormatter: format</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; format(&quot;docs&quot;);</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: IOError: realpath(&quot;docs&quot;): no such file or directory (ENOENT)</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; format(&quot;src&quot;);</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: IOError: realpath(&quot;src&quot;): no such file or directory (ENOENT)</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; format(&quot;test&quot;);</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: IOError: realpath(&quot;test&quot;): no such file or directory (ENOENT)</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>A continuous integration check verifies that all PRs made to EasyJobs have passed the formatter.</p></div></div><p>The following sections outline extra style guide points that are not fixed automatically by JuliaFormatter.</p><h3 id="Use-the-Julia-extension-for-Visual-Studio-Code"><a class="docs-heading-anchor" href="#Use-the-Julia-extension-for-Visual-Studio-Code">Use the Julia extension for Visual Studio Code</a><a id="Use-the-Julia-extension-for-Visual-Studio-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Use-the-Julia-extension-for-Visual-Studio-Code" title="Permalink"></a></h3><p>Please use <a href="https://code.visualstudio.com/">VS Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=julialang.language-julia">Julia extension</a> to edit, format, and test your code. We do not recommend using other editors to edit your code for the time being.</p><p>This extension already has <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> integrated. So to format your code, follow the steps listed <a href="https://www.julia-vscode.org/docs/stable/userguide/formatter/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../design-principles/">Design Principles »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 1 August 2023 20:58">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>