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.

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

Simplify the quickstart example #1047

Merged
merged 1 commit into from
Jul 21, 2024
Merged

Simplify the quickstart example #1047

merged 1 commit into from
Jul 21, 2024

Conversation

nbelakovski
Copy link
Contributor

Personally, I found the quickstart example to be jumbled and a little confusing. It was hard for me to tell where I would put my own code to react to file system events (indeed the quickstart never showed how to do this).

I also think the selection of the path using sys.argv and place everything under "if name == main" is unnecessary for the simple example.

I hope you find this helpful.

Personally, I found the quickstart example to be jumbled and a little
confusing. It was hard for me to tell where I would put my own code to
react to file system events (indeed the quickstart never showed how to
do this).

I also think the selection of the path using sys.argv and place
everything under "if name == main" is unnecessary for the simple
example.
@BoboTiG BoboTiG merged commit 402ad01 into gorakhargosh:master Jul 21, 2024
@BoboTiG
Copy link
Collaborator

BoboTiG commented Jul 21, 2024

I like it, thanks @nbelakovski !

github-actions bot pushed a commit to wxx9248/Pickle-Rush that referenced this pull request Aug 12, 2024
Bumps [watchdog](https://github.com/gorakhargosh/watchdog) from 4.0.1 to
4.0.2.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/gorakhargosh/watchdog/releases">watchdog's
releases</a>.</em></p>
<blockquote>
<h2>4.0.2</h2>
<ul>
<li>Add support for Python 3.13 (<a
href="https://github.com/gorakhargosh/watchdog/issues/1052">#1052</a>)</li>
<li>[core] Run <code>ruff</code>, apply several fixes (<a
href="https://github.com/gorakhargosh/watchdog/issues/1033">#1033</a>)</li>
<li>[core] Remove execution rights from <code>events.py</code></li>
<li>[documentation] Update <code>PatternMatchingEventHandler</code>
docstrings (<a
href="https://github.com/gorakhargosh/watchdog/issues/1048">#1048</a>)</li>
<li>[documentation] Simplify the quickstart example (<a
href="https://github.com/gorakhargosh/watchdog/issues/1047">#1047</a>)</li>
<li>[fsevents] Add missing <code>event_filter</code> keyword-argument to
<code>FSEventsObserver.schedule()</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1049">#1049</a>)</li>
<li>[utils] Fix a possible race condition in
<code>AutoRestartTrick</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1002">#1002</a>)</li>
<li>[watchmedo] Remove execution rights from
<code>watchmedo.py</code></li>
</ul>
<p>:heart_decoration: Thanks to our beloved contributors: <a
href="https://github.com/BoboTiG"><code>@​BoboTiG</code></a>, <a
href="https://github.com/nbelakovski"><code>@​nbelakovski</code></a>, <a
href="https://github.com/ivg"><code>@​ivg</code></a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/gorakhargosh/watchdog/blob/master/changelog.rst">watchdog's
changelog</a>.</em></p>
<blockquote>
<p>4.0.2</p>
<pre><code>
2024-08-11 • `full history
&lt;https://github.com/gorakhargosh/watchdog/compare/v4.0.1...v4.0.2&gt;`__
<ul>
<li>Add support for Python 3.13
(<code>[#1052](gorakhargosh/watchdog#1052)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1052&amp;gt;</code>__)</li>
<li>[core] Run <code>ruff</code>, apply several fixes
(<code>[#1033](gorakhargosh/watchdog#1033)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1033&amp;gt;</code>__)</li>
<li>[core] Remove execution rights from <code>events.py</code></li>
<li>[documentation] Update <code>PatternMatchingEventHandler</code>
docstrings
(<code>[#1048](gorakhargosh/watchdog#1048)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1048&amp;gt;</code>__)</li>
<li>[documentation] Simplify the quickstart example
(<code>[#1047](gorakhargosh/watchdog#1047)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1047&amp;gt;</code>__)</li>
<li>[fsevents] Add missing <code>event_filter</code> keyword-argument to
<code>FSEventsObserver.schedule()</code>
(<code>[#1049](gorakhargosh/watchdog#1049)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1049&amp;gt;</code>__)</li>
<li>[utils] Fix a possible race condition in
<code>AutoRestartTrick</code>
(<code>[#1002](gorakhargosh/watchdog#1002)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1002&amp;gt;</code>__)</li>
<li>[watchmedo] Remove execution rights from
<code>watchmedo.py</code></li>
<li>Thanks to our beloved contributors: <a
href="https://github.com/BoboTiG"><code>@​BoboTiG</code></a>, <a
href="https://github.com/nbelakovski"><code>@​nbelakovski</code></a>, <a
href="https://github.com/ivg"><code>@​ivg</code></a>
</code></pre></li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/9c5a43241f774930e958447b61a83b8bbd94fb21"><code>9c5a432</code></a>
Version 4.0.2</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/aac4328e593e8764c6a3face67961f955d64bb74"><code>aac4328</code></a>
chore: add git attributes file</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/6a33516b8cb87a04a2e208c7a794e58f40f6f9b9"><code>6a33516</code></a>
docs: tweak</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/cff604e90bc562dee16a32efbe6b4471d3e64105"><code>cff604e</code></a>
feat: Python 3.13 support (<a
href="https://github.com/gorakhargosh/watchdog/issues/1052">#1052</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7503d34c1f49a96c7ab31b177f6f3a3ffc8ab049"><code>7503d34</code></a>
fix: possible race condition in <code>AutoRestartTrick</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1002">#1002</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7d4a369e82eea79ef281febb03d9267805f746bb"><code>7d4a369</code></a>
[core] Run ruff, apply several fixes (<a
href="https://github.com/gorakhargosh/watchdog/issues/1033">#1033</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7cd723ac433781002062fdf6f6400043f0d9d55d"><code>7cd723a</code></a>
chore: partly move settings from <code>setup.cfg</code> to
<code>pyproject.toml</code></li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/654707e7e640d5b1d15e3714ba4ce54a3597bce9"><code>654707e</code></a>
fix: remove execution rights from <code>events.py</code>, and
<code>watchmedo.py</code>, files</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/4043ef098214732662950c06c2b39407804b3153"><code>4043ef0</code></a>
tests: improve flakyness + clean-up</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/206843c8bc22210c6bd95537fc28d87c552d03d0"><code>206843c</code></a>
chore: remove useless kwarg on <code>BaseObserver</code> subclasses</li>
<li>Additional commits viewable in <a
href="https://github.com/gorakhargosh/watchdog/compare/v4.0.1...v4.0.2">compare
view</a></li>
</ul>
</details>
<br />


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

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually 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>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
cdnninja pushed a commit to Hyundai-Kia-Connect/hyundai_kia_connect_api that referenced this pull request Aug 16, 2024
Bumps [watchdog](https://github.com/gorakhargosh/watchdog) from 4.0.1 to
4.0.2.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/gorakhargosh/watchdog/releases">watchdog's
releases</a>.</em></p>
<blockquote>
<h2>4.0.2</h2>
<ul>
<li>Add support for Python 3.13 (<a
href="https://github.com/gorakhargosh/watchdog/issues/1052">#1052</a>)</li>
<li>[core] Run <code>ruff</code>, apply several fixes (<a
href="https://github.com/gorakhargosh/watchdog/issues/1033">#1033</a>)</li>
<li>[core] Remove execution rights from <code>events.py</code></li>
<li>[documentation] Update <code>PatternMatchingEventHandler</code>
docstrings (<a
href="https://github.com/gorakhargosh/watchdog/issues/1048">#1048</a>)</li>
<li>[documentation] Simplify the quickstart example (<a
href="https://github.com/gorakhargosh/watchdog/issues/1047">#1047</a>)</li>
<li>[fsevents] Add missing <code>event_filter</code> keyword-argument to
<code>FSEventsObserver.schedule()</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1049">#1049</a>)</li>
<li>[utils] Fix a possible race condition in
<code>AutoRestartTrick</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1002">#1002</a>)</li>
<li>[watchmedo] Remove execution rights from
<code>watchmedo.py</code></li>
</ul>
<p>:heart_decoration: Thanks to our beloved contributors: <a
href="https://github.com/BoboTiG"><code>@​BoboTiG</code></a>, <a
href="https://github.com/nbelakovski"><code>@​nbelakovski</code></a>, <a
href="https://github.com/ivg"><code>@​ivg</code></a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/gorakhargosh/watchdog/blob/master/changelog.rst">watchdog's
changelog</a>.</em></p>
<blockquote>
<p>4.0.2</p>
<pre><code>
2024-08-11 • `full history
&lt;https://github.com/gorakhargosh/watchdog/compare/v4.0.1...v4.0.2&gt;`__
<ul>
<li>Add support for Python 3.13
(<code>[#1052](gorakhargosh/watchdog#1052)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1052&amp;gt;</code>__)</li>
<li>[core] Run <code>ruff</code>, apply several fixes
(<code>[#1033](gorakhargosh/watchdog#1033)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1033&amp;gt;</code>__)</li>
<li>[core] Remove execution rights from <code>events.py</code></li>
<li>[documentation] Update <code>PatternMatchingEventHandler</code>
docstrings
(<code>[#1048](gorakhargosh/watchdog#1048)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1048&amp;gt;</code>__)</li>
<li>[documentation] Simplify the quickstart example
(<code>[#1047](gorakhargosh/watchdog#1047)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1047&amp;gt;</code>__)</li>
<li>[fsevents] Add missing <code>event_filter</code> keyword-argument to
<code>FSEventsObserver.schedule()</code>
(<code>[#1049](gorakhargosh/watchdog#1049)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1049&amp;gt;</code>__)</li>
<li>[utils] Fix a possible race condition in
<code>AutoRestartTrick</code>
(<code>[#1002](gorakhargosh/watchdog#1002)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1002&amp;gt;</code>__)</li>
<li>[watchmedo] Remove execution rights from
<code>watchmedo.py</code></li>
<li>Thanks to our beloved contributors: <a
href="https://github.com/BoboTiG"><code>@​BoboTiG</code></a>, <a
href="https://github.com/nbelakovski"><code>@​nbelakovski</code></a>, <a
href="https://github.com/ivg"><code>@​ivg</code></a>
</code></pre></li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/9c5a43241f774930e958447b61a83b8bbd94fb21"><code>9c5a432</code></a>
Version 4.0.2</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/aac4328e593e8764c6a3face67961f955d64bb74"><code>aac4328</code></a>
chore: add git attributes file</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/6a33516b8cb87a04a2e208c7a794e58f40f6f9b9"><code>6a33516</code></a>
docs: tweak</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/cff604e90bc562dee16a32efbe6b4471d3e64105"><code>cff604e</code></a>
feat: Python 3.13 support (<a
href="https://github.com/gorakhargosh/watchdog/issues/1052">#1052</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7503d34c1f49a96c7ab31b177f6f3a3ffc8ab049"><code>7503d34</code></a>
fix: possible race condition in <code>AutoRestartTrick</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1002">#1002</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7d4a369e82eea79ef281febb03d9267805f746bb"><code>7d4a369</code></a>
[core] Run ruff, apply several fixes (<a
href="https://github.com/gorakhargosh/watchdog/issues/1033">#1033</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7cd723ac433781002062fdf6f6400043f0d9d55d"><code>7cd723a</code></a>
chore: partly move settings from <code>setup.cfg</code> to
<code>pyproject.toml</code></li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/654707e7e640d5b1d15e3714ba4ce54a3597bce9"><code>654707e</code></a>
fix: remove execution rights from <code>events.py</code>, and
<code>watchmedo.py</code>, files</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/4043ef098214732662950c06c2b39407804b3153"><code>4043ef0</code></a>
tests: improve flakyness + clean-up</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/206843c8bc22210c6bd95537fc28d87c552d03d0"><code>206843c</code></a>
chore: remove useless kwarg on <code>BaseObserver</code> subclasses</li>
<li>Additional commits viewable in <a
href="https://github.com/gorakhargosh/watchdog/compare/v4.0.1...v4.0.2">compare
view</a></li>
</ul>
</details>
<br />


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

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually 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>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
miniscruff pushed a commit to miniscruff/scopie that referenced this pull request Aug 28, 2024
Bumps the pip-deps group with 4 updates in the / directory:
[idna](https://github.com/kjd/idna),
[markdown](https://github.com/Python-Markdown/markdown),
[mkdocs-material](https://github.com/squidfunk/mkdocs-material) and
[watchdog](https://github.com/gorakhargosh/watchdog).

Updates `idna` from 3.7 to 3.8
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/kjd/idna/releases">idna's
releases</a>.</em></p>
<blockquote>
<h2>v3.8</h2>
<h2>What's Changed</h2>
<ul>
<li>Fix regression where IDNAError exception was not being produced for
certain inputs.</li>
<li>Add support for Python 3.13, drop support for Python 3.5 as it is no
longer testable.</li>
<li>Documentation improvements</li>
<li>Updates to package testing using Github actions</li>
</ul>
<p>Thanks to Hugo van Kemenade for contributions to this release.</p>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/kjd/idna/compare/v3.7...v3.8">https://github.com/kjd/idna/compare/v3.7...v3.8</a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/kjd/idna/blob/master/HISTORY.rst">idna's
changelog</a>.</em></p>
<blockquote>
<p>3.8 (2024-08-23)
++++++++++++++++</p>
<ul>
<li>Fix regression where IDNAError exception was not being produced for
certain inputs.</li>
<li>Add support for Python 3.13, drop support for Python 3.5 as it is no
longer testable.</li>
<li>Documentation improvements</li>
<li>Updates to package testing using Github actions</li>
</ul>
<p>Thanks to Hugo van Kemenade for contributions to this release.</p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/kjd/idna/commit/784c6f45c162db9709588124f2f1def5b70615ff"><code>784c6f4</code></a>
Release v3.8</li>
<li><a
href="https://github.com/kjd/idna/commit/28c7c9e250c81c41cbce34e2f5b684345367c486"><code>28c7c9e</code></a>
Typo fix</li>
<li><a
href="https://github.com/kjd/idna/commit/a2b41c386e8e973757c69648a431d32f8ba4db69"><code>a2b41c3</code></a>
Pin remainder of Github Actions flagged in code scanning</li>
<li><a
href="https://github.com/kjd/idna/commit/1f613c53c6c725c76431671451a92f48e7a2e917"><code>1f613c5</code></a>
More Github Action dependency pinning</li>
<li><a
href="https://github.com/kjd/idna/commit/a87e2b6fd38b4c42d6ab3cdc0cb820ac4c6218dc"><code>a87e2b6</code></a>
Update OSSF scorecard to latest version</li>
<li><a
href="https://github.com/kjd/idna/commit/12d4dd133964b84a5b67d3b99b78d38be0c696c5"><code>12d4dd1</code></a>
Merge pull request <a
href="https://github.com/kjd/idna/issues/182">#182</a> from
kjd/github-pypi-actions</li>
<li><a
href="https://github.com/kjd/idna/commit/e1a15412eb0de3de9b7bee345e9888d46f32cde4"><code>e1a1541</code></a>
Pin Github Actions dependencies</li>
<li><a
href="https://github.com/kjd/idna/commit/c109d3a80b769ce49fa23951b6d64ad9d43fda51"><code>c109d3a</code></a>
Merge branch 'master' into github-pypi-actions</li>
<li><a
href="https://github.com/kjd/idna/commit/f8a8de43db509c7e7fa0e9e08a7e7f1fe1c1a165"><code>f8a8de4</code></a>
Do not try to build/send packages to TestPyPI for now</li>
<li><a
href="https://github.com/kjd/idna/commit/613bdde233107a84958e5aa1174068f88728829a"><code>613bdde</code></a>
Update regexp to move global flag to start of expression</li>
<li>Additional commits viewable in <a
href="https://github.com/kjd/idna/compare/v3.7...v3.8">compare
view</a></li>
</ul>
</details>
<br />

Updates `markdown` from 3.6 to 3.7
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Python-Markdown/markdown/releases">markdown's
releases</a>.</em></p>
<blockquote>
<h2>Release 3.7</h2>
<h3>Changed</h3>
<h4>Refactor <code>abbr</code> Extension</h4>
<p>A new <code>AbbrTreeprocessor</code> has been introduced, which
replaces the now deprecated
<code>AbbrInlineProcessor</code>. Abbreviation processing now happens
after Attribute Lists,
avoiding a conflict between the two extensions (<a
href="https://github.com/Python-Markdown/markdown/issues/1460">#1460</a>).</p>
<p>The <code>AbbrPreprocessor</code> class has been renamed to
<code>AbbrBlockprocessor</code>, which
better reflects what it is. <code>AbbrPreprocessor</code> has been
deprecated.</p>
<p>A call to <code>Markdown.reset()</code> now clears all previously
defined abbreviations.</p>
<p>Abbreviations are now sorted by length before executing
<code>AbbrTreeprocessor</code>
to ensure that multi-word abbreviations are implemented even if an
abbreviation
exists for one of those component words. (<a
href="https://github.com/Python-Markdown/markdown/issues/1465">#1465</a>)</p>
<p>Abbreviations without a definition are now ignored. This avoids
applying
abbr tags to text without a title value.</p>
<p>Added an optional <code>glossary</code> configuration option to the
abbreviations extension.
This provides a simple and efficient way to apply a dictionary of
abbreviations
to every page.</p>
<p>Abbreviations can now be disabled by setting their definition to
<code>&quot;&quot;</code> or <code>''</code>.
This can be useful when using the <code>glossary</code> option.</p>
<h3>Fixed</h3>
<ul>
<li>Fixed links to source code on GitHub from the documentation (<a
href="https://github.com/Python-Markdown/markdown/issues/1453">#1453</a>).</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/Python-Markdown/markdown/blob/master/docs/changelog.md">markdown's
changelog</a>.</em></p>
<blockquote>
<h2>[3.7] -- 2024-08-16</h2>
<h3>Changed</h3>
<h4>Refactor <code>abbr</code> Extension</h4>
<p>A new <code>AbbrTreeprocessor</code> has been introduced, which
replaces the now deprecated
<code>AbbrInlineProcessor</code>. Abbreviation processing now happens
after Attribute Lists,
avoiding a conflict between the two extensions (<a
href="https://github.com/Python-Markdown/markdown/issues/1460">#1460</a>).</p>
<p>The <code>AbbrPreprocessor</code> class has been renamed to
<code>AbbrBlockprocessor</code>, which
better reflects what it is. <code>AbbrPreprocessor</code> has been
deprecated.</p>
<p>A call to <code>Markdown.reset()</code> now clears all previously
defined abbreviations.</p>
<p>Abbreviations are now sorted by length before executing
<code>AbbrTreeprocessor</code>
to ensure that multi-word abbreviations are implemented even if an
abbreviation
exists for one of those component words. (<a
href="https://github.com/Python-Markdown/markdown/issues/1465">#1465</a>)</p>
<p>Abbreviations without a definition are now ignored. This avoids
applying
abbr tags to text without a title value.</p>
<p>Added an optional <code>glossary</code> configuration option to the
abbreviations extension.
This provides a simple and efficient way to apply a dictionary of
abbreviations
to every page.</p>
<p>Abbreviations can now be disabled by setting their definition to
<code>&quot;&quot;</code> or <code>''</code>.
This can be useful when using the <code>glossary</code> option.</p>
<h3>Fixed</h3>
<ul>
<li>Fixed links to source code on GitHub from the documentation (<a
href="https://github.com/Python-Markdown/markdown/issues/1453">#1453</a>).</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/Python-Markdown/markdown/commit/da03cd646d00a77786ae1e0bc79b01a5539852bc"><code>da03cd6</code></a>
Bump version to 3.7</li>
<li><a
href="https://github.com/Python-Markdown/markdown/commit/bd836a1448963081b221ad899399e20bb1ccb857"><code>bd836a1</code></a>
Update griffe_extensions to support Griffe v 1.0.</li>
<li><a
href="https://github.com/Python-Markdown/markdown/commit/33359faa385f59b84cd87df5f4b0996055a482e2"><code>33359fa</code></a>
Abbr Extension: Definition Sorting and Glossary storage</li>
<li><a
href="https://github.com/Python-Markdown/markdown/commit/ec8c305fb14eb081bb874c917d8b91d3c5122334"><code>ec8c305</code></a>
Refactor <code>abbr</code> Extension</li>
<li><a
href="https://github.com/Python-Markdown/markdown/commit/993b57b8ea577f2120f7d0c81b45ee5ed74a0f57"><code>993b57b</code></a>
Fixed links to source code on GitHub from the documentation</li>
<li>See full diff in <a
href="https://github.com/Python-Markdown/markdown/compare/3.6...3.7">compare
view</a></li>
</ul>
</details>
<br />

Updates `mkdocs-material` from 9.5.31 to 9.5.33
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/squidfunk/mkdocs-material/releases">mkdocs-material's
releases</a>.</em></p>
<blockquote>
<h2>mkdocs-material-9.5.33</h2>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7453">#7453</a>:
Incorrect position of tooltip when sorting table</li>
</ul>
<h2>mkdocs-material-9.5.32</h2>
<ul>
<li>Fixed RXSS vulnerability via deep link in search results</li>
<li>Added support for fetching latest release from GitLab</li>
</ul>
<p>Thanks go to <a
href="https://github.com/joaopalmeiro"><code>@​joaopalmeiro</code></a>
for their contributions</p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG">mkdocs-material's
changelog</a>.</em></p>
<blockquote>
<p>mkdocs-material-9.5.33 (2024-08-23)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7453">#7453</a>:
Incorrect position of tooltip when sorting table</li>
</ul>
<p>mkdocs-material-9.5.32 (2024-08-19)</p>
<ul>
<li>Fixed RXSS vulnerability via deep link in search results</li>
<li>Added support for fetching latest release from GitLab</li>
</ul>
<p>mkdocs-material-9.5.31+insiders-4.53.12 (2024-08-02)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7410">#7410</a>:
Instant previews jump on content tabs with anchor links</li>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7408">#7408</a>:
Instant previews jump on content tabs</li>
</ul>
<p>mkdocs-material-9.5.31 (2024-08-02)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7405">#7405</a>:
DockerHub missing images &gt; 9.5.27 due to change in Alpine/APK</li>
</ul>
<p>mkdocs-material-9.5.30 (2024-07-23)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7380">#7380</a>:
Navigation icons disappearing on hover in Safari</li>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7367">#7367</a>:
Blog readtime computation includes SVG text content</li>
</ul>
<p>mkdocs-material-9.5.29 (2024-07-14)</p>
<ul>
<li>Updated Galician translations</li>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7362">#7362</a>:
Annotations in figure captions rendering incorrectly</li>
</ul>
<p>mkdocs-material-9.5.28 (2024-07-02)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7313">#7313</a>:
Improved tooltips mounted in sidebar when feature is disabled</li>
</ul>
<p>mkdocs-material-9.5.27 (2024-06-16)</p>
<ul>
<li>Updated Estonian translations</li>
</ul>
<p>mkdocs-material-9.5.26 (2024-06-06)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7232">#7232</a>:
Tab switches on scroll when linking tabs (9.5.19 regression)</li>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7230">#7230</a>:
Blog author avatar broken when referring to local file</li>
</ul>
<p>mkdocs-material-9.5.25+insiders-4.53.11 (2024-05-27)</p>
<ul>
<li>Fixed projects plugin crashing when serving before building
subprojects</li>
</ul>
<p>mkdocs-material-9.5.25 (2024-05-27)</p>
<ul>
<li>Fixed <a
href="https://github.com/squidfunk/mkdocs-material/issues/7209">#7209</a>:
Tags plugin crashing on numeric tags</li>
</ul>
<p>mkdocs-material-9.5.24+insiders-4.53.10 (2024-05-20)</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/a91ee70faf2ac51eeed0a3f7d70a626a8aa98675"><code>a91ee70</code></a>
Prepare 9.5.33 release</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/4104fafe3c5f26a97b2e500bf770048f19d290ca"><code>4104faf</code></a>
Updated dependencies</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/8ee7137e48bd59ef451b20fb14c6c86fa6132da1"><code>8ee7137</code></a>
Updated premium sponsors</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/e1c1bad46dd7016adff9842626d91ef4319e340c"><code>e1c1bad</code></a>
Updated blog post</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/24455371814c37650fbfc0a0393ac3268fe495ba"><code>2445537</code></a>
Removed pyodide_macros plugin's schema (<a
href="https://github.com/squidfunk/mkdocs-material/issues/7468">#7468</a>)</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/47f7f631043b3d862a7dd88dc9f742b0e143c47b"><code>47f7f63</code></a>
Added plugins to &quot;external-community&quot; in plugins.json (<a
href="https://github.com/squidfunk/mkdocs-material/issues/7465">#7465</a>)</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/42ab11ff4cb2acdb854642edf49153e61ec7ed03"><code>42ab11f</code></a>
Added <code>edit_uri_template</code> to docs/schema.json (<a
href="https://github.com/squidfunk/mkdocs-material/issues/7466">#7466</a>)</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/e5c9575dda8b4e8b689efffda2690f5925ae7919"><code>e5c9575</code></a>
Fixed invalid tooltip position in tables when using table sort</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/7a770dc7bec546b2da2b0e45bcce8076d791504b"><code>7a770dc</code></a>
Updated blog post</li>
<li><a
href="https://github.com/squidfunk/mkdocs-material/commit/4030f531082e810bd5819c872ce0c6aa44f732ad"><code>4030f53</code></a>
Prepare 9.5.32 release</li>
<li>Additional commits viewable in <a
href="https://github.com/squidfunk/mkdocs-material/compare/9.5.31...9.5.33">compare
view</a></li>
</ul>
</details>
<br />

Updates `watchdog` from 4.0.1 to 4.0.2
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/gorakhargosh/watchdog/releases">watchdog's
releases</a>.</em></p>
<blockquote>
<h2>4.0.2</h2>
<ul>
<li>Add support for Python 3.13 (<a
href="https://github.com/gorakhargosh/watchdog/issues/1052">#1052</a>)</li>
<li>[core] Run <code>ruff</code>, apply several fixes (<a
href="https://github.com/gorakhargosh/watchdog/issues/1033">#1033</a>)</li>
<li>[core] Remove execution rights from <code>events.py</code></li>
<li>[documentation] Update <code>PatternMatchingEventHandler</code>
docstrings (<a
href="https://github.com/gorakhargosh/watchdog/issues/1048">#1048</a>)</li>
<li>[documentation] Simplify the quickstart example (<a
href="https://github.com/gorakhargosh/watchdog/issues/1047">#1047</a>)</li>
<li>[fsevents] Add missing <code>event_filter</code> keyword-argument to
<code>FSEventsObserver.schedule()</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1049">#1049</a>)</li>
<li>[utils] Fix a possible race condition in
<code>AutoRestartTrick</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1002">#1002</a>)</li>
<li>[watchmedo] Remove execution rights from
<code>watchmedo.py</code></li>
</ul>
<p>:heart_decoration: Thanks to our beloved contributors: <a
href="https://github.com/BoboTiG"><code>@​BoboTiG</code></a>, <a
href="https://github.com/nbelakovski"><code>@​nbelakovski</code></a>, <a
href="https://github.com/ivg"><code>@​ivg</code></a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/gorakhargosh/watchdog/blob/master/changelog.rst">watchdog's
changelog</a>.</em></p>
<blockquote>
<p>4.0.2</p>
<pre><code>
2024-08-11 • `full history
&lt;https://github.com/gorakhargosh/watchdog/compare/v4.0.1...v4.0.2&gt;`__
<ul>
<li>Add support for Python 3.13
(<code>[#1052](gorakhargosh/watchdog#1052)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1052&amp;gt;</code>__)</li>
<li>[core] Run <code>ruff</code>, apply several fixes
(<code>[#1033](gorakhargosh/watchdog#1033)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1033&amp;gt;</code>__)</li>
<li>[core] Remove execution rights from <code>events.py</code></li>
<li>[documentation] Update <code>PatternMatchingEventHandler</code>
docstrings
(<code>[#1048](gorakhargosh/watchdog#1048)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1048&amp;gt;</code>__)</li>
<li>[documentation] Simplify the quickstart example
(<code>[#1047](gorakhargosh/watchdog#1047)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1047&amp;gt;</code>__)</li>
<li>[fsevents] Add missing <code>event_filter</code> keyword-argument to
<code>FSEventsObserver.schedule()</code>
(<code>[#1049](gorakhargosh/watchdog#1049)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1049&amp;gt;</code>__)</li>
<li>[utils] Fix a possible race condition in
<code>AutoRestartTrick</code>
(<code>[#1002](gorakhargosh/watchdog#1002)
&amp;lt;https://github.com/gorakhargosh/watchdog/pull/1002&amp;gt;</code>__)</li>
<li>[watchmedo] Remove execution rights from
<code>watchmedo.py</code></li>
<li>Thanks to our beloved contributors: <a
href="https://github.com/BoboTiG"><code>@​BoboTiG</code></a>, <a
href="https://github.com/nbelakovski"><code>@​nbelakovski</code></a>, <a
href="https://github.com/ivg"><code>@​ivg</code></a>
</code></pre></li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/9c5a43241f774930e958447b61a83b8bbd94fb21"><code>9c5a432</code></a>
Version 4.0.2</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/aac4328e593e8764c6a3face67961f955d64bb74"><code>aac4328</code></a>
chore: add git attributes file</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/6a33516b8cb87a04a2e208c7a794e58f40f6f9b9"><code>6a33516</code></a>
docs: tweak</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/cff604e90bc562dee16a32efbe6b4471d3e64105"><code>cff604e</code></a>
feat: Python 3.13 support (<a
href="https://github.com/gorakhargosh/watchdog/issues/1052">#1052</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7503d34c1f49a96c7ab31b177f6f3a3ffc8ab049"><code>7503d34</code></a>
fix: possible race condition in <code>AutoRestartTrick</code> (<a
href="https://github.com/gorakhargosh/watchdog/issues/1002">#1002</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7d4a369e82eea79ef281febb03d9267805f746bb"><code>7d4a369</code></a>
[core] Run ruff, apply several fixes (<a
href="https://github.com/gorakhargosh/watchdog/issues/1033">#1033</a>)</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/7cd723ac433781002062fdf6f6400043f0d9d55d"><code>7cd723a</code></a>
chore: partly move settings from <code>setup.cfg</code> to
<code>pyproject.toml</code></li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/654707e7e640d5b1d15e3714ba4ce54a3597bce9"><code>654707e</code></a>
fix: remove execution rights from <code>events.py</code>, and
<code>watchmedo.py</code>, files</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/4043ef098214732662950c06c2b39407804b3153"><code>4043ef0</code></a>
tests: improve flakyness + clean-up</li>
<li><a
href="https://github.com/gorakhargosh/watchdog/commit/206843c8bc22210c6bd95537fc28d87c552d03d0"><code>206843c</code></a>
chore: remove useless kwarg on <code>BaseObserver</code> subclasses</li>
<li>Additional commits viewable in <a
href="https://github.com/gorakhargosh/watchdog/compare/v4.0.1...v4.0.2">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually 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 <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants