Skip to content

Commit bafaef0

Browse files
nshiabnshiab
committed
update documentation
1 parent d7d805f commit bafaef0

11 files changed

+45
-44
lines changed

‎docs/functions/adjustToInflation.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>adjustToInflation | Journalism - v0.2.0</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>adjustToInflation | Journalism - v0.2.1</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.1</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-content">
@@ -40,7 +40,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
4040
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
4141
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
4242
<ul>
43-
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/f4e51b0/src/finance/adjustToInflation.ts#L11">finance/adjustToInflation.ts:11</a></li></ul></aside></li></ul></section></div>
43+
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/d7d805f/src/finance/adjustToInflation.ts#L11">finance/adjustToInflation.ts:11</a></li></ul></aside></li></ul></section></div>
4444
<div class="col-sidebar">
4545
<div class="page-menu">
4646
<div class="tsd-navigation settings">
@@ -57,7 +57,7 @@ <h4 class="uppercase">Member Visibility</h4><form>
5757
<div class="tsd-theme-toggle">
5858
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
5959
<div class="site-menu">
60-
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.0</span></a>
60+
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.1</span></a>
6161
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
6262
<li><a href="adjustToInflation.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>adjustToInflation</a></li>
6363
<li><a href="distance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>distance</a></li>

‎docs/functions/distance.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>distance | Journalism - v0.2.0</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>distance | Journalism - v0.2.1</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.1</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-content">
@@ -42,7 +42,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
4242
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
4343
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
4444
<ul>
45-
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/f4e51b0/src/geo/distance.ts#L12">geo/distance.ts:12</a></li></ul></aside></li></ul></section></div>
45+
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/d7d805f/src/geo/distance.ts#L12">geo/distance.ts:12</a></li></ul></aside></li></ul></section></div>
4646
<div class="col-sidebar">
4747
<div class="page-menu">
4848
<div class="tsd-navigation settings">
@@ -59,7 +59,7 @@ <h4 class="uppercase">Member Visibility</h4><form>
5959
<div class="tsd-theme-toggle">
6060
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
6161
<div class="site-menu">
62-
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.0</span></a>
62+
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.1</span></a>
6363
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
6464
<li><a href="adjustToInflation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>adjustToInflation</a></li>
6565
<li><a href="distance.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>distance</a></li>

‎docs/functions/formatDate.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatDate | Journalism - v0.2.0</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatDate | Journalism - v0.2.1</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.1</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-content">
@@ -41,7 +41,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
4141
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
4242
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
4343
<ul>
44-
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/f4e51b0/src/format/formatDate.ts#L16">format/formatDate.ts:16</a></li></ul></aside></li></ul></section></div>
44+
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/d7d805f/src/format/formatDate.ts#L16">format/formatDate.ts:16</a></li></ul></aside></li></ul></section></div>
4545
<div class="col-sidebar">
4646
<div class="page-menu">
4747
<div class="tsd-navigation settings">
@@ -58,7 +58,7 @@ <h4 class="uppercase">Member Visibility</h4><form>
5858
<div class="tsd-theme-toggle">
5959
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
6060
<div class="site-menu">
61-
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.0</span></a>
61+
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.1</span></a>
6262
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
6363
<li><a href="adjustToInflation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>adjustToInflation</a></li>
6464
<li><a href="distance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>distance</a></li>

‎docs/functions/formatDateLocal.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatDateLocal | Journalism - v0.2.0</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatDateLocal | Journalism - v0.2.1</title><meta name="description" content="Documentation for Journalism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Journalism - v0.2.1</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-content">
@@ -41,7 +41,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
4141
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
4242
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
4343
<ul>
44-
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/f4e51b0/src/format/formatDateLocal.ts#L16">format/formatDateLocal.ts:16</a></li></ul></aside></li></ul></section></div>
44+
<li>Defined in <a href="https://github.com/nshiab/journalism/blob/d7d805f/src/format/formatDateLocal.ts#L16">format/formatDateLocal.ts:16</a></li></ul></aside></li></ul></section></div>
4545
<div class="col-sidebar">
4646
<div class="page-menu">
4747
<div class="tsd-navigation settings">
@@ -58,7 +58,7 @@ <h4 class="uppercase">Member Visibility</h4><form>
5858
<div class="tsd-theme-toggle">
5959
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
6060
<div class="site-menu">
61-
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.0</span></a>
61+
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Journalism - v0.2.1</span></a>
6262
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
6363
<li><a href="adjustToInflation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>adjustToInflation</a></li>
6464
<li><a href="distance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>distance</a></li>

0 commit comments

Comments
 (0)