Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review documentation #59

Merged
merged 38 commits into from
Dec 31, 2023
Merged

Review documentation #59

merged 38 commits into from
Dec 31, 2023

Conversation

RKrahl
Copy link
Owner

@RKrahl RKrahl commented Dec 31, 2021 •
edited
Loading

Several improvements to the documentation:

This is not yet final. Still TODO:

  • add a better introduction to the debugging guide,
  • review README and include it as long description to the package metadata,
  • review install instructions,
  • add GitHub action to check ReST style of documentation sources.

RKrahl added 22 commits May 10, 2020 21:38
@RKrahl
Review formatting of the changelog and include it in the source
c8e19d8 
distribution.
@RKrahl
Minor changes to the documentation.
0862cda
@RKrahl
Merge branch 'develop' into doc
235a5d3
@RKrahl
Merge branch 'develop' into doc
2807908
@RKrahl
Add an example on how to implement an or-like dependency. Ref. #53, #57
886c254
@RKrahl
Minor edit in docstring
2ad740b
@RKrahl
Merge branch 'develop' into doc
76145ef
@RKrahl
Merge branch 'develop' into doc
0e7ef81
@RKrahl
Fix typos in the documentation
77b9c1e
@RKrahl
Add a documentation section on logical combinations of dependencies
5adffde
@RKrahl
Add test for the logical combinations of dependencies example
a8cb125
@RKrahl
Document that the dependency marker may be applied to a class as a
65dc1f5 
whole.  Close #39.
@RKrahl
Add a warning that the documented solution for logical combinations of
b945b95 
dependencies is based on undocumented pytest features
@RKrahl
Merge branch 'develop' into doc
291b7bb
@RKrahl
Start writing a debugging guide
1d88f4d
@RKrahl
Expand the debugging example, including several samples of potential
58ff4ff 
issues
@RKrahl
Add detailed discussion of the example in the debugging guide
10f9e61
@RKrahl
Merge branch 'doc' into doc-debug
46e6a8f
@RKrahl
Add test for the debugging example
9bf329b
@RKrahl
Merge branch 'doc-debug' into doc
190b920
@RKrahl
Skip test_debugging in Python 2.7
b913403
@RKrahl
Remove spurious white space
1a1cfda
@RKrahl RKrahl added the documentation Improvements or additions to documentation label Dec 31, 2021
@RKrahl RKrahl added this to the 0.6 milestone Dec 31, 2021
@RKrahl RKrahl marked this pull request as ready for review December 31, 2023 19:45
@RKrahl RKrahl merged commit 2baac9b into develop Dec 31, 2023
8 checks passed
@RKrahl RKrahl deleted the doc branch December 31, 2023 20:08
github-merge-queue bot referenced this pull request in linz/topo-imagery Sep 8, 2024
@dependabot
build(deps-dev): bump pytest-dependency from 0.5.1 to 0.6.0 (#803)
69b5dd8 
[//]: # (dependabot-start)
⚠️  **Dependabot is rebasing this PR** ⚠️ 

Rebasing might not happen immediately, so don't worry if this takes some
time.

Note: if you make any changes to this PR yourself, they will take
precedence over the rebase.

---

[//]: # (dependabot-end)

Bumps [pytest-dependency](https://github.com/RKrahl/pytest-dependency)
from 0.5.1 to 0.6.0.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/RKrahl/pytest-dependency/blob/develop/CHANGES.rst">pytest-dependency's
changelog</a>.</em></p>
<blockquote>
<p>0.6.0 (2023-12-31)</p>
<pre><code>
Documentation
-------------
<ul>

<li><code>[#39](https://github.com/RKrahl/pytest-dependency/issues/39)</code><em>,
<code>[#41](https://github.com/RKrahl/pytest-dependency/issues/41)</code></em>,
<code>[#59](https://github.com/RKrahl/pytest-dependency/issues/59)</code>_:
Review documentation</li>
</ul>
<h2>Incompatible changes</h2>
<ul>
<li>Drop support for Python 2.</li>
</ul>
<h2>Bug fixes and minor changes</h2>
<ul>

<li><code>[#40](https://github.com/RKrahl/pytest-dependency/issues/40)</code>_:
add logging.</li>

<li><code>[#50](https://github.com/RKrahl/pytest-dependency/issues/50)</code><em>,
<code>[#51](https://github.com/RKrahl/pytest-dependency/issues/51)</code></em>:
test suite incompatibility with pytest 6.2.0.</li>

<li><code>[#58](https://github.com/RKrahl/pytest-dependency/issues/58)</code>_:
declare the type of automark_dependency ini-option correctly
as bool.</li>
</ul>
<h2>Internal</h2>
<ul>

<li><code>[#75](https://github.com/RKrahl/pytest-dependency/issues/75)</code>_:
review build tool chain.</li>
</ul>
<p>.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/39">#39</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/39">RKrahl/pytest-dependency#39</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/40">#40</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/40">RKrahl/pytest-dependency#40</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/41">#41</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/41">RKrahl/pytest-dependency#41</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/50">#50</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/50">RKrahl/pytest-dependency#50</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/51">#51</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/pull/51">RKrahl/pytest-dependency#51</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/58">#58</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/pull/58">RKrahl/pytest-dependency#58</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/59">#59</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/pull/59">RKrahl/pytest-dependency#59</a>
.. _<a
href="https://redirect.github.com/RKrahl/pytest-dependency/issues/75">#75</a>:
<a
href="https://redirect.github.com/RKrahl/pytest-dependency/pull/75">RKrahl/pytest-dependency#75</a>
</code></pre></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/2cae58956bff640bbfbbdc8212cae97b7967453c"><code>2cae589</code></a>
Merge branch 'develop'</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/def647eda5778fc5b0ffebb7251c81e804f50089"><code>def647e</code></a>
Prepare release 0.6.0</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/2baac9b866777f8fa353defe6c4a770f0df90d85"><code>2baac9b</code></a>
Merge branch 'doc' into develop</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/38baf8cb5f561dcf16539c8304b0f71898a625f6"><code>38baf8c</code></a>
Update changelog</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/e2edf54383b3b8f2c137d78677debfd63b23ba95"><code>e2edf54</code></a>
Explicitely set language to 'en'</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/f11cf56ca553992891d80ce79bbbac82aa40d285"><code>f11cf56</code></a>
Rewrite introduction to the debugging guide</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/346a3441efbf26dfad83e277ab6ccac26cfe6d75"><code>346a344</code></a>
Move the changelog to the end, after the API reference</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/463227e4519e444701f22acadf3442c1b45e5214"><code>463227e</code></a>
Review README and bump copyright year</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/eb48f326af4428f7e292bc980c80a02686650832"><code>eb48f32</code></a>
Fixup 695ea27: trailing whitespace</li>
<li><a
href="https://github.com/RKrahl/pytest-dependency/commit/695ea2742af78fe65a5b17426170b481666ec0a2"><code>695ea27</code></a>
Update install instructions</li>
<li>Additional commits viewable in <a
href="https://github.com/RKrahl/pytest-dependency/compare/0.5.1...0.6.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pytest-dependency&package-manager=pip&previous-version=0.5.1&new-version=0.6.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

> **Note**
> Automatic rebases have been disabled on this pull request as it has
been open for over 30 days.

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.6
1 participant
@RKrahl