Skip to content

Commit

Permalink
Update generated documentation for version 1.3.49
Browse files Browse the repository at this point in the history
  • Loading branch information
Thorium committed Nov 7, 2024
1 parent f45c412 commit 9c5a150
Show file tree
Hide file tree
Showing 126 changed files with 1,215 additions and 5,836 deletions.
74 changes: 37 additions & 37 deletions core/async.html

Large diffs are not rendered by default.

44 changes: 22 additions & 22 deletions core/composable.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions core/constraints-relationships.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
</li>
<li class="nav-item ">
<a class="nav-link" href="https://fsprojects.github.io/SQLProvider/core/contributing.html">
How to contribute
How to make a contribution

</a>
</li>
Expand Down Expand Up @@ -250,12 +250,12 @@ <H1 style="font-size: 24px;">SQLProvider</H1>
<div id="content">
<h1><a name="Constraints-amp-Relationships" class="anchor" href="#Constraints-amp-Relationships">Constraints &amp; Relationships</a></h1>
<p>A typical relational database will have many connected tables and views
through foreign key constraints. The SQL provider can show you these
through foreign key constraints. The SQL provider is able to show you these
constraints on entities. They appear as properties named the same as the
constraint in the database.</p>
<p>You can gain access to these child or parent entities by simply enumerating
the property in question.</p>
<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>
<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>


</div>
Expand Down
28 changes: 14 additions & 14 deletions core/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
<meta content="pezipink,colinbull,thorium" name="author">
<!-- Opengraph properties (https://ogp.me/) -->
<meta property="og:site_name" content="SQLProvider">
<meta property="og:title" content="How to contribute
<meta property="og:title" content="How to make a contribution
" />
<meta property="og:url" content="https://fsprojects.github.io/SQLProvider/core/contributing.html">
<meta property="og:type" content="website" />
<!-- Twitter cards (https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary-card-with-large-image) -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="https://fsprojects.github.io/SQLProvider/">
<meta name="twitter:title" content="How to contribute
<meta name="twitter:title" content="How to make a contribution
">

<title>How to contribute
<title>How to make a contribution
| SQLProvider</title>
<link href="https://fonts.googleapis.com" rel="preconnect">
<link crossorigin href="https://fonts.gstatic.com" rel="preconnect">
Expand Down Expand Up @@ -70,7 +70,7 @@
</li>
<li class="nav-item active">
<a class="nav-link" href="https://fsprojects.github.io/SQLProvider/core/contributing.html">
How to contribute
How to make a contribution

</a>
</li>
Expand Down Expand Up @@ -248,36 +248,36 @@ <H1 style="font-size: 24px;">SQLProvider</H1>
</aside>
<main>
<div id="content">
<h1><a name="How-to-contribute" class="anchor" href="#How-to-contribute">How to contribute</a></h1>
<h1><a name="How-to-make-a-contribution" class="anchor" href="#How-to-make-a-contribution">How to make a contribution</a></h1>
<p>This is how you can make a "pull request", to suggest your modifications to be accepted to the code base.</p>
<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>
<p>(Or take <code>git pull</code> if you already have the repository.)</p>
<p><img src="https://imgur.com/FFSDb0L.png" alt="Download" /></p>
<p>You need to get the .git folder inside the repository.
If the download doesn't work, you can use clone, which creates a separate folder and downloads the repository:</p>
If the download doesn't work you can use clone, which creates a separate folder and downloads the repository:</p>
<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>
</code></pre>
<h3><a name="2-Edit-and-Commit" class="anchor" href="#2-Edit-and-Commit">2. Edit and Commit</a></h3>
<p>Here are some <a href="techdetails.html">tech details</a>.</p>
<p>Do the modifications and check the build and tests are working. Commit the changes to your local repository.</p>
<p>Do the modifications, check the build and tests are working. Commit the modifications to your local repository.</p>
<h3><a name="3-Fork-the-GitHub-repository" class="anchor" href="#3-Fork-the-GitHub-repository">3. Fork the GitHub repository.</a></h3>
<p>This will "copy" the repository for your account.</p>
<p><img src="https://imgur.com/cMOSS1R.png" alt="Fork" /></p>
<h3><a name="4-Get-Your-Url" class="anchor" href="#4-Get-Your-Url">4. Get Your Url</a></h3>
<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>
<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>
<h3><a name="5-Add-a-Remote" class="anchor" href="#5-Add-a-Remote">5. Add a Remote</a></h3>
<p>With command line, add a remote to your repository URL:</p>
<p>With command line, add a remote to your repository url:</p>
<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>
</code></pre>
<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>
<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>
<h3><a name="6-Push-to-Your-Remote" class="anchor" href="#6-Push-to-Your-Remote">6. Push to Your Remote</a></h3>
<p>Push the latest version to your repository with
<code>git push myrepo</code>. You should see the modifications in GitHub under your repository.</p>
<h3><a name="7-Create-a-Pull-Request" class="anchor" href="#7-Create-a-Pull-Request">7. Create a Pull Request</a></h3>
<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>
<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>
<p><img src="https://imgur.com/CD525AG.png" alt="PullRequest" /></p>
<h3><a name="8-Done" class="anchor" href="#8-Done">8. Done.</a></h3>
<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>
<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>
<p><img src="https://i.imgur.com/BrngItg.png" alt="The process" /></p>


Expand All @@ -287,8 +287,8 @@ <h3><a name="8-Done" class="anchor" href="#8-Done">8. Done.</a></h3>
<p id="on-this-page">On this page</p>
<ul>
<li class="level-1">
<a href="#How-to-contribute">
How to contribute
<a href="#How-to-make-a-contribution">
How to make a contribution
</a>
</li>
<li class="level-3">
Expand Down
Loading

0 comments on commit 9c5a150

Please sign in to comment.