2f1014aa60
Black dropped us 5 years ago
...
31f4105731
2024-09-05 09:02:00 +02:00
8a8cd91bdf
Switch docstrings to Napoleon style ( #1308 )
...
* Switch docstrings to Napoleon style
This makes them much more readable while editing.
c.f. https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
* Add example for Raises
2024-07-21 12:06:19 +02:00
feb7a4d892
Fix typo
2024-07-19 13:02:13 +02:00
28adb06aaf
Remove hatch run due to unpredictable Python version
2024-07-19 12:56:28 +02:00
52dfaf00ed
Streamline contributing
...
Make it less of an incomplete Git tutorial and more GitHub-adjacent.
Also add a Hatch script to just run tests without dealing with venvs.
2024-07-19 12:31:59 +02:00
0a2b73891f
Fixes tox command for watching docs in CONTRIBUTING.md ( #1250 )
...
Fixes tox command for watching docs
2024-02-29 04:28:04 +00:00
c365b3e9a6
update contributing
2023-12-30 13:05:53 +01:00
73374ba65e
Remove spurious changes
2023-08-17 09:23:41 +02:00
16dfa9f713
Stop using nodeenv ( #1178 )
...
Constant downloading of Node & Pyright is flaky and a waste of resources.
2023-08-17 09:20:45 +02:00
26c5b9da86
Stop installing docs dependencies into dev environment
...
It's a lot of dependencies.
2023-07-09 11:41:34 +02:00
0a02d34f57
Use a distinct file name for default python versions ( #1146 )
...
* Use a distinct file name for default python versions
* Inspect bash settings
* Revert "Inspect bash settings"
This reverts commit b2f52baaeb
2023-06-13 09:40:14 +02:00
747b9ded2f
Simplify CI and use .python-version ( #1140 )
...
* Simplify CI and use .python-version
* Test CI on pypy 3.9 too
* We don't need .gitignore to keep the dir anymore
2023-06-04 07:33:48 +02:00
e4c9f2796c
CONTRIBUTING: Small improvements ( #1123 )
...
* Small improvements to docs
* Corrected branch deletion
* Apply suggestions from code review
Co-authored-by: Hynek Schlawack <hs@ox.cx>
* Applied more review feedback
---------
Co-authored-by: Hynek Schlawack <hs@ox.cx>
2023-04-14 04:38:00 +00:00
f04fa4ed8e
CONTRIBUTING: Added instructions for PR workflow ( #1105 )
...
* CONTRIBUTING: Added instructions for PR workflow
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Added changelog entry
* Use inline code for changelog filename
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
* Add console prompt to command
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
* Made some more improvements
* Apply suggestions from code review
* Update .github/CONTRIBUTING.md
* Update changelog.d/1105.change.md
* Update .github/CONTRIBUTING.md
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
* Update .github/CONTRIBUTING.md
* Update .github/CONTRIBUTING.md
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Hynek Schlawack <hs@ox.cx>
2023-04-03 16:34:43 +00:00
f2571ea144
Simplify contributing guide
2023-02-12 09:48:38 +01:00
afe211143d
Switch changelog to markdown ( #1067 )
...
* Switch changelog to markdown
* Add changelog except back to long description
* Fix MANIFEST.in
* Re-add towncrier draft entries
* Write the title outselves
* Add warning box
* Make changelog format more KeepAChangelog-ish
* Link latest changes to main tree
* Move link into warning
* KAC has no empty lines between entries
* There's no more .rst in the root dir
2022-12-07 09:15:46 +01:00
95841fc93e
Start moving docs to MyST / Markdown ( #1053 )
...
* Start moving to MyST
* More MyST
* Start using proper typography
2022-11-16 13:58:25 +01:00
20453b1a61
Minor docs polish
2022-08-23 10:12:44 +02:00
fdf824211f
Fix pre-commit link syntax in contributing doc ( #1018 )
...
It was using RST but the doc is actually in Markdown.
2022-08-22 16:09:55 +02:00
70b3cf16e1
Use pytest-xdist in tox / CI ( #1011 )
...
Co-authored-by: Thomas Grainger <413772+graingert@users.noreply.github.com>
Co-authored-by: Ionel Cristian Mărieș <129501+ionelmc@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <578543+webknjaz@users.noreply.github.com>
2022-08-21 09:38:37 +02:00
307a6467d3
Minor docs fixes
2022-08-19 09:03:06 +02:00
0c19e1600e
Stop installing pre-commit in dev
...
It's not necessary thanks to tox & pre-commit ci and it's kinda overbearing
towards people who already have it installed.
2022-08-11 10:09:37 +02:00
a3d7f20e54
Polish contributing guide
2022-07-28 09:46:31 +02:00
17e1ba54c8
Fix typo in tox wiki link in CONTRIBUTING.md ( #982 )
2022-07-15 08:10:26 +00:00
980c8b04f5
Drop Python 2.7 ( #936 )
...
* Drop Python 2.7
The tooling situation around Python 2 has deteriorate to such a degree that
upholding compatibility is not tenable anymore for a volunteer-run project.
Signed-off-by: Hynek Schlawack <hs@ox.cx>
* Add newsfragment
* Run Python 3.5 under coverage to make up for Python 2.7
* Wait for py35 in parallel
* Remove fullmatch kludge
* Remove Python 2-specific code
* Revert empty slot test
Also disable pyupgrade on that file.
Signed-off-by: Hynek Schlawack <hs@ox.cx>
* We DO run under 3.5
* Remove __qualname__ workarounds
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Update changelog.d/936.breaking.rst
Co-authored-by: Tin Tvrtković <tinchester@gmail.com>
* Compare methods using is
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Tin Tvrtković <tinchester@gmail.com>
2022-03-21 08:47:47 +01:00
112e50fcfa
Use :pep:`#` in Sphinx files & move the rest to new URL
2022-03-10 13:58:57 +01:00
20bf4b6e54
Go over CONTRIBUTING.md
2021-12-28 06:57:34 +01:00
ebe158cf8a
Add more sensical example
2021-11-26 07:19:16 +01:00
ff65c6e645
Link to more concrete blog post
2021-11-26 07:16:31 +01:00
0b95a0c76c
Fold backward-compatibility into changelog
...
Signed-off-by: Hynek Schlawack <hs@ox.cx>
2021-11-25 17:06:12 +01:00
b403b91f48
Forgotten rst
2021-11-25 10:00:10 +01:00
e82e340422
Smarten some endashes
...
Signed-off-by: Hynek Schlawack <hs@ox.cx>
2021-11-25 09:40:13 +01:00
d6771729c5
Update CONTRIBUTING.md
2021-11-25 09:38:19 +01:00
16cf4c50a0
GitHub really wants us to use Markdown
...
Signed-off-by: Hynek Schlawack <hs@ox.cx>
2021-11-25 09:31:17 +01:00
Hynek Schlawack