Skip to content

Commit

Permalink
docs: update documentation to v0.11.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user @haltcase
actions-user authored and haltcase committed Jan 30, 2024
1 parent 7cc7207 commit b40b4ac
Show file tree
Hide file tree
Showing 15 changed files with 4,944 additions and 2,055 deletions.
2,462 changes: 1,015 additions & 1,447 deletions latest/dochack.js
View file

Large diffs are not rendered by default.

478 changes: 222 additions & 256 deletions latest/glob.html
View file

Large diffs are not rendered by default.

48 changes: 25 additions & 23 deletions latest/glob.idx
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
Glob glob.html#Glob glob: Glob
GlobEntry glob.html#GlobEntry glob: GlobEntry
PatternStems glob.html#PatternStems glob: PatternStems
GlobOption glob.html#GlobOption glob: GlobOption
GlobOptions glob.html#GlobOptions glob: GlobOptions
FilterDescend glob.html#FilterDescend glob: FilterDescend
FilterYield glob.html#FilterYield glob: FilterYield
defaultGlobOptions glob.html#defaultGlobOptions glob: defaultGlobOptions
hasMagic glob.html#hasMagic,string glob: hasMagic(str: string): bool
globToRegex glob.html#globToRegex,string glob: globToRegex(pattern: string; isDos = isDosDefault; ignoreCase = isDosDefault): Regex
splitPattern glob.html#splitPattern,string glob: splitPattern(pattern: string): PatternStems
glob glob.html#glob,string glob: glob(pattern: string; isDos = isDosDefault; ignoreCase = isDosDefault): Glob
matches glob.html#matches,string,Glob glob: matches(input: string; glob: Glob): bool
matches glob.html#matches,string,string glob: matches(input, pattern: string; isDos = isDosDefault; ignoreCase = isDosDefault): bool
walkGlobKinds glob.html#walkGlobKinds.i,,string,FilterDescend,FilterYield glob: walkGlobKinds(pattern: string | Glob; root = ""; options = defaultGlobOptions;\n filterDescend: FilterDescend = nil; filterYield: FilterYield = nil): GlobEntry
walkGlob glob.html#walkGlob.i,,string,FilterDescend,FilterYield glob: walkGlob(pattern: string | Glob; root = ""; options = defaultGlobOptions;\n filterDescend: FilterDescend = nil; filterYield: FilterYield = nil): string
Syntax glob.html#syntax Syntax
Character classes glob.html#syntax-character-classes Character classes
Matching special characters glob.html#character-classes-matching-special-characters Matching special characters
POSIX classes glob.html#character-classes-posix-classes POSIX classes
Extended pattern matching glob.html#syntax-extended-pattern-matching Extended pattern matching
Examples glob.html#examples Examples
Roadmap glob.html#roadmap Roadmap
nimTitle glob glob.html module src/glob 0
nim Glob glob.html#Glob object Glob 152
nim GlobEntry glob.html#GlobEntry tuple GlobEntry 162
nim PatternStems glob.html#PatternStems tuple PatternStems 167
nim GlobOption glob.html#GlobOption enum GlobOption 174
nim GlobOptions glob.html#GlobOptions type GlobOptions 194
nim FilterDescend glob.html#FilterDescend type FilterDescend 201
nim FilterYield glob.html#FilterYield type FilterYield 209
nim defaultGlobOptions glob.html#defaultGlobOptions const defaultGlobOptions 218
nim hasMagic glob.html#hasMagic,string proc hasMagic(str: string): bool 234
nim globToRegex glob.html#globToRegex,string proc globToRegex(pattern: string; isDos = isDosDefault; ignoreCase = isDosDefault): Regex 337
nim splitPattern glob.html#splitPattern,string proc splitPattern(pattern: string): PatternStems 341
nim glob glob.html#glob,string proc glob(pattern: string; isDos = isDosDefault; ignoreCase = isDosDefault): Glob 364
nim matches glob.html#matches,string,Glob proc matches(input: string; glob: Glob): bool 379
nim matches glob.html#matches,string,string proc matches(input, pattern: string; isDos = isDosDefault; ignoreCase = isDosDefault): bool 397
nim walkGlobKinds glob.html#walkGlobKinds.i,,string,FilterDescend,FilterYield iterator walkGlobKinds(pattern: string | Glob; root = ""; options = defaultGlobOptions;\n filterDescend: FilterDescend = nil; filterYield: FilterYield = nil): GlobEntry 450
nim walkGlob glob.html#walkGlob.i,,string,FilterDescend,FilterYield iterator walkGlob(pattern: string | Glob; root = ""; options = defaultGlobOptions;\n filterDescend: FilterDescend = nil; filterYield: FilterYield = nil): string 564
nimgrp matches glob.html#matches-procs-all proc 379
heading Syntax glob.html#syntax Syntax 0
heading Character classes glob.html#syntax-character-classes Character classes 0
heading Matching special characters glob.html#character-classes-matching-special-characters Matching special characters 0
heading POSIX classes glob.html#character-classes-posix-classes POSIX classes 0
heading Extended pattern matching glob.html#syntax-extended-pattern-matching Extended pattern matching 0
heading Examples glob.html#examples Examples 0
heading Roadmap glob.html#roadmap Roadmap 0
153 changes: 56 additions & 97 deletions latest/glob/regexer.html
View file
Original file line number Diff line number Diff line change
@@ -1,76 +1,27 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>src/glob/regexer</title>

<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">

<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>

<!-- CSS -->
<title>src/glob/regexer</title>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">

<script type="text/javascript" src="../dochack.js"></script>

<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}

function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}

const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
if (toggleSwitch !== null) {
toggleSwitch.addEventListener('change', switchTheme, false);
}

var currentTheme = localStorage.getItem('theme');
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
currentTheme = 'dark';
}
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);

if (currentTheme === 'dark' && toggleSwitch !== null) {
toggleSwitch.checked = true;
}
}
}

window.addEventListener('DOMContentLoaded', main);
</script>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css?v=2.0.2">

<!-- JS -->
<script type="text/javascript" src="../dochack.js?v=2.0.2"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">src/glob/regexer</h1>
<div class="row">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">src/glob/regexer</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
Expand All @@ -85,7 +36,7 @@ <h1 class="title">src/glob/regexer</h1>
<a href="../theindex.html">Index</a>
</li>
<li>
<a href="https://github.com/citycide/glob">GitHub</a>
<a href="https://github.com/haltcase/glob">GitHub</a>
</li>
</ul>
</div>
Expand All @@ -101,26 +52,28 @@ <h1 class="title">src/glob/regexer</h1>
</select>
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#GlobSyntaxError"
title="GlobSyntaxError = object of CatchableError">GlobSyntaxError</a></li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#GlobSyntaxError" title="GlobSyntaxError = object of CatchableError">GlobSyntaxError</a></li>

</ul>
</ul>
</details>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">globToRegexString
<li><a class="reference" href="#globToRegexString%2Cstring"
title="globToRegexString(pattern: string; isDos = isDosDefault;
<li><a class="reference" href="#globToRegexString%2Cstring" title="globToRegexString(pattern: string; isDos = isDosDefault;
ignoreCase = isDosDefault): string">globToRegexString(pattern: string; isDos = isDosDefault;
ignoreCase = isDosDefault): string</a></li>

</ul>
</ul>

</ul>
</ul>
</details>
</li>

</ul>
Expand All @@ -132,47 +85,53 @@ <h1 class="title">src/glob/regexer</h1>

<p class="module-desc">This module provides the backend for glob pattern parsing and the compilation to regular expressions. While it's re-exported from the main module and importing it separately isn't necessary, it could be imported independently of the main <tt class="docutils literal"><span class="pre">glob</span></tt> package. </p>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="GlobSyntaxError">
<dt><pre><a href="regexer.html#GlobSyntaxError"><span class="Identifier">GlobSyntaxError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span>
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="GlobSyntaxError">
<dt><pre><a href="regexer.html#GlobSyntaxError"><span class="Identifier">GlobSyntaxError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span>
</pre></dt>
<dd>

Raised if the parsing of a glob pattern fails.

</dd>
<dd>
Raised if the parsing of a glob pattern fails.
</dd>
</div>

</dl></div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="globToRegexString,string">
<dt><pre><span class="Keyword">proc</span> <a href="#globToRegexString%2Cstring"><span class="Identifier">globToRegexString</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">isDos</span> <span class="Other">=</span> <span class="Identifier">isDosDefault</span><span class="Other">;</span>
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="globToRegexString-procs-all">
<div id="globToRegexString,string">
<dt><pre><span class="Keyword">proc</span> <a href="#globToRegexString%2Cstring"><span class="Identifier">globToRegexString</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">isDos</span> <span class="Other">=</span> <span class="Identifier">isDosDefault</span><span class="Other">;</span>
<span class="Identifier">ignoreCase</span> <span class="Other">=</span> <span class="Identifier">isDosDefault</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">GlobSyntaxError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>

Parses the given <tt class="docutils literal"><span class="pre">pattern</span></tt> glob string and returns a regex string. Syntactic errors will cause a <tt class="docutils literal"><span class="pre">GlobSyntaxError</span></tt> to be raised.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">GlobSyntaxError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>

Parses the given <tt class="docutils literal"><span class="pre">pattern</span></tt> glob string and returns a regex string. Syntactic errors will cause a <tt class="docutils literal"><span class="pre">GlobSyntaxError</span></tt> to be raised.

</dd>
</div>

</dd>
</div>

</dl></div>
</dl>
</div>

</div>
</div>

<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2022-10-14 21:19:11 UTC</small>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-30 22:21:44 UTC</small>
</div>
</div>
</div>
</div>


<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
</body>
</html>
5 changes: 3 additions & 2 deletions latest/glob/regexer.idx
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
GlobSyntaxError glob/regexer.html#GlobSyntaxError regexer: GlobSyntaxError
globToRegexString glob/regexer.html#globToRegexString,string regexer: globToRegexString(pattern: string; isDos = isDosDefault;\n ignoreCase = isDosDefault): string
nimTitle regexer glob/regexer.html module src/glob/regexer 0
nim GlobSyntaxError glob/regexer.html#GlobSyntaxError object GlobSyntaxError 10
nim globToRegexString glob/regexer.html#globToRegexString,string proc globToRegexString(pattern: string; isDos = isDosDefault;\n ignoreCase = isDosDefault): string 46
Loading

0 comments on commit b40b4ac

Please sign in to comment.