Skip to content

Commit 5f85c6c

Browse files
committed
Update generated documentation for version 1.4.6
1 parent 58d38a2 commit 5f85c6c

File tree

127 files changed

+6405
-1414
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+6405
-1414
lines changed

core/async.html

Lines changed: 31 additions & 31 deletions
Large diffs are not rendered by default.

core/composable.html

Lines changed: 20 additions & 20 deletions
Large diffs are not rendered by default.

core/constraints-relationships.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
</li>
7171
<li class="nav-item ">
7272
<a class="nav-link" href="https://fsprojects.github.io/SQLProvider/core/contributing.html">
73-
How to make a contribution
73+
How to contribute
7474

7575
</a>
7676
</li>
@@ -250,12 +250,12 @@ <H1 style="font-size: 24px;">SQLProvider</H1>
250250
<div id="content">
251251
<h1><a name="Constraints-amp-Relationships" class="anchor" href="#Constraints-amp-Relationships">Constraints &amp; Relationships</a></h1>
252252
<p>A typical relational database will have many connected tables and views
253-
through foreign key constraints. The SQL provider is able to show you these
253+
through foreign key constraints. The SQL provider can show you these
254254
constraints on entities. They appear as properties named the same as the
255255
constraint in the database.</p>
256256
<p>You can gain access to these child or parent entities by simply enumerating
257257
the property in question.</p>
258-
<p>While SQL provider automatically generates getters from foreign key relations, it doesn't have (yet) any automatic support for creating a properly ordered graph of related entities in a single transaction. However, SQL provider submits entities to a database in the same order they were created, which means that as long as you create entities in their dependency order, you won't get foreign key constraint violations.</p>
258+
<p>While SQL provider automatically generates getters from foreign-key relations, it doesn't have (yet) any automatic support for creating a properly ordered graph of related entities in a single transaction. However, SQL provider submits entities to a database in the same order they were created. As long as you create entities in their dependency order, you won't get foreign-key constraint violations.</p>
259259

260260

261261
</div>

core/contributing.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
<meta content="pezipink,colinbull,thorium" name="author">
88
<!-- Opengraph properties (https://ogp.me/) -->
99
<meta property="og:site_name" content="SQLProvider">
10-
<meta property="og:title" content="How to make a contribution
10+
<meta property="og:title" content="How to contribute
1111
" />
1212
<meta property="og:url" content="https://fsprojects.github.io/SQLProvider/core/contributing.html">
1313
<meta property="og:type" content="website" />
1414
<!-- Twitter cards (https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary-card-with-large-image) -->
1515
<meta name="twitter:card" content="summary_large_image">
1616
<meta name="twitter:site" content="https://fsprojects.github.io/SQLProvider/">
17-
<meta name="twitter:title" content="How to make a contribution
17+
<meta name="twitter:title" content="How to contribute
1818
">
1919

20-
<title>How to make a contribution
20+
<title>How to contribute
2121
| SQLProvider</title>
2222
<link href="https://fonts.googleapis.com" rel="preconnect">
2323
<link crossorigin href="https://fonts.gstatic.com" rel="preconnect">
@@ -70,7 +70,7 @@
7070
</li>
7171
<li class="nav-item active">
7272
<a class="nav-link" href="https://fsprojects.github.io/SQLProvider/core/contributing.html">
73-
How to make a contribution
73+
How to contribute
7474

7575
</a>
7676
</li>
@@ -248,36 +248,36 @@ <H1 style="font-size: 24px;">SQLProvider</H1>
248248
</aside>
249249
<main>
250250
<div id="content">
251-
<h1><a name="How-to-make-a-contribution" class="anchor" href="#How-to-make-a-contribution">How to make a contribution</a></h1>
251+
<h1><a name="How-to-contribute" class="anchor" href="#How-to-contribute">How to contribute</a></h1>
252252
<p>This is how you can make a "pull request", to suggest your modifications to be accepted to the code base.</p>
253253
<h3><a name="1-Download-or-clone-the-repository-to-your-computer" class="anchor" href="#1-Download-or-clone-the-repository-to-your-computer">1. Download or clone the repository to your computer.</a></h3>
254254
<p>(Or take <code>git pull</code> if you already have the repository.)</p>
255255
<p><img src="https://imgur.com/FFSDb0L.png" alt="Download" /></p>
256256
<p>You need to get the .git folder inside the repository.
257-
If the download doesn't work you can use clone, which creates a separate folder and downloads the repository:</p>
257+
If the download doesn't work, you can use clone, which creates a separate folder and downloads the repository:</p>
258258
<pre class="fssnip highlighted"><code lang="fsharp"> <span class="id">git</span> <span class="id">clone</span> <span class="id">https</span><span class="pn">:</span><span class="c">//github.com/fsprojects/SQLProvider.git</span>
259259
</code></pre>
260260
<h3><a name="2-Edit-and-Commit" class="anchor" href="#2-Edit-and-Commit">2. Edit and Commit</a></h3>
261261
<p>Here are some <a href="techdetails.html">tech details</a>.</p>
262-
<p>Do the modifications, check the build and tests are working. Commit the modifications to your local repository.</p>
262+
<p>Do the modifications and check the build and tests are working. Commit the changes to your local repository.</p>
263263
<h3><a name="3-Fork-the-GitHub-repository" class="anchor" href="#3-Fork-the-GitHub-repository">3. Fork the GitHub repository.</a></h3>
264264
<p>This will "copy" the repository for your account.</p>
265265
<p><img src="https://imgur.com/cMOSS1R.png" alt="Fork" /></p>
266266
<h3><a name="4-Get-Your-Url" class="anchor" href="#4-Get-Your-Url">4. Get Your Url</a></h3>
267-
<p>In GitHub, go to <strong>your</strong> copy of the repository (under your profile, Repositories-tab) and under Download, get the repository url, e.g. <a href="https://github.com/myname/SqlProvider.git">https://github.com/myname/SqlProvider.git</a></p>
267+
<p>In GitHub, go to <strong>your</strong> copy of the repository (under your profile, Repositories-tab) and under Download, get the repository URL, e.g. <a href="https://github.com/myname/SqlProvider.git">https://github.com/myname/SqlProvider.git</a></p>
268268
<h3><a name="5-Add-a-Remote" class="anchor" href="#5-Add-a-Remote">5. Add a Remote</a></h3>
269-
<p>With command line, add a remote to your repository url:</p>
269+
<p>With command line, add a remote to your repository URL:</p>
270270
<pre class="fssnip highlighted"><code lang="fsharp"> <span class="id">git</span> <span class="id">remote</span> <span class="id">add</span> <span class="id">myrepo</span> <span class="id">https</span><span class="pn">:</span><span class="c">//github.com/myname/SqlProvider.git</span>
271271
</code></pre>
272-
<p>Use the name you want for repository and note your GitHub account in the url. You can check the remotes with <code>git remote -v</code>.</p>
272+
<p>Use the name you want for the repository and note your GitHub account in the URL. You can check the remotes with <code>git remote -v</code>.</p>
273273
<h3><a name="6-Push-to-Your-Remote" class="anchor" href="#6-Push-to-Your-Remote">6. Push to Your Remote</a></h3>
274274
<p>Push the latest version to your repository with
275275
<code>git push myrepo</code>. You should see the modifications in GitHub under your repository.</p>
276276
<h3><a name="7-Create-a-Pull-Request" class="anchor" href="#7-Create-a-Pull-Request">7. Create a Pull Request</a></h3>
277-
<p>In GitHub under <strong>your</strong> repository press the Create pull request -button. By default, everything should be correct: Base-fork is the one where you want to send the modifications and head fork is your fork, so follow the wizard.</p>
277+
<p>In GitHub, under <strong>your</strong> repository, press the Create pull request -button. By default, everything should be correct: The base-fork is the one to which you want to send the modifications, and the head fork is your fork, so follow the wizard.</p>
278278
<p><img src="https://imgur.com/CD525AG.png" alt="PullRequest" /></p>
279279
<h3><a name="8-Done" class="anchor" href="#8-Done">8. Done.</a></h3>
280-
<p>Your pull request should be visible under "Pull requests" -tab in original repository. When you do more commits, you can ignore parts 3, 4 and 5, they has to be done just once.</p>
280+
<p>Your pull request should be visible under the "Pull requests" -tab in the original repository. When you do more commits, you can ignore parts 3, 4 and 5, they has to be done just once.</p>
281281
<p><img src="https://i.imgur.com/BrngItg.png" alt="The process" /></p>
282282

283283

@@ -287,8 +287,8 @@ <h3><a name="8-Done" class="anchor" href="#8-Done">8. Done.</a></h3>
287287
<p id="on-this-page">On this page</p>
288288
<ul>
289289
<li class="level-1">
290-
<a href="#How-to-make-a-contribution">
291-
How to make a contribution
290+
<a href="#How-to-contribute">
291+
How to contribute
292292
</a>
293293
</li>
294294
<li class="level-3">

0 commit comments

Comments
 (0)