Skip to content

Commit

Permalink
docs: update URLs master => main
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Nov 2, 2022
1 parent 598c578 commit 58f1549
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ When contributing pull requests, it's a good idea to run basic checks locally:

```bash
# install development dependencies
shtab (master)$ pip install pre-commit -r requirements-dev.txt
shtab (master)$ pre-commit install # install pre-commit checks
shtab (master)$ pytest # run all tests
shtab (main)$ pip install pre-commit -r requirements-dev.txt
shtab (main)$ pre-commit install # install pre-commit checks
shtab (main)$ pytest # run all tests
```

## Layout
Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,16 +102,16 @@ Please do open `issues <https://github.com/iterative/shtab/issues>`_ & `pull req
- support ``powershell``

See
`CONTRIBUTING.md <https://github.com/iterative/shtab/tree/master/CONTRIBUTING.md>`_
`CONTRIBUTING.md <https://github.com/iterative/shtab/tree/main/CONTRIBUTING.md>`_
for more guidance.

|Hits|

.. |Logo| image:: https://github.com/iterative/shtab/raw/master/meta/logo.png
.. |Logo| image:: https://github.com/iterative/shtab/raw/main/meta/logo.png
.. |Tests| image:: https://github.com/iterative/shtab/workflows/Test/badge.svg
:target: https://github.com/iterative/shtab/actions
:alt: Tests
.. |Coverage| image:: https://codecov.io/gh/iterative/shtab/branch/master/graph/badge.svg
.. |Coverage| image:: https://codecov.io/gh/iterative/shtab/branch/main/graph/badge.svg
:target: https://codecov.io/gh/iterative/shtab
:alt: Coverage
.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/shtab.svg?label=conda&logo=conda-forge
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![shtab](https://static.iterative.ai/img/shtab/banner.png)

[![Tests](https://github.com/iterative/shtab/workflows/Test/badge.svg)](https://github.com/iterative/shtab/actions)
[![Coverage](https://codecov.io/gh/iterative/shtab/branch/master/graph/badge.svg)](https://codecov.io/gh/iterative/shtab)
[![Coverage](https://codecov.io/gh/iterative/shtab/branch/main/graph/badge.svg)](https://codecov.io/gh/iterative/shtab)
[![conda-forge](https://img.shields.io/conda/v/conda-forge/shtab.svg?label=conda&logo=conda-forge)](https://anaconda.org/conda-forge/shtab)
[![PyPI](https://img.shields.io/pypi/v/shtab.svg?label=pip&logo=PyPI&logoColor=white)](https://pypi.org/project/shtab)

Expand Down Expand Up @@ -113,7 +113,7 @@ Please do open [issues][GH-issue] & [pull requests][GH-pr]! Some ideas:
- support `powershell`

See
[CONTRIBUTING.md](https://github.com/iterative/shtab/tree/master/CONTRIBUTING.md)
[CONTRIBUTING.md](https://github.com/iterative/shtab/tree/main/CONTRIBUTING.md)
for more guidance.

[![Hits](https://caspersci.uk.to/cgi-bin/hits.cgi?q=shtab&style=social&r=https://github.com/iterative/shtab&a=hidden)](https://caspersci.uk.to/cgi-bin/hits.cgi?q=shtab&a=plot&r=https://github.com/iterative/shtab&style=social)
Expand Down
4 changes: 2 additions & 2 deletions docs/pydoc-markdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ renderer:
generator: false
theme:
name: material
logo: https://github.com/iterative/shtab/raw/master/meta/logo.png
favicon: https://github.com/iterative/shtab/raw/master/meta/logo.png
logo: https://github.com/iterative/shtab/raw/main/meta/logo.png
favicon: https://github.com/iterative/shtab/raw/main/meta/logo.png
palette:
- scheme: default
primary: white
Expand Down
8 changes: 4 additions & 4 deletions docs/use.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Below are various examples of enabling `shtab`'s own tab completion scripts.
```

!!! tip
See the [examples/](https://github.com/iterative/shtab/tree/master/examples)
See the [examples/](https://github.com/iterative/shtab/tree/main/examples)
folder for more.

Any existing `argparse`-based scripts should be supported with minimal effort.
Expand Down Expand Up @@ -148,14 +148,14 @@ Assuming this code example is installed in `MY_PROG.command.main`, simply run:
## Library Usage

!!! tip
See the [examples/](https://github.com/iterative/shtab/tree/master/examples)
See the [examples/](https://github.com/iterative/shtab/tree/main/examples)
folder for more.

Complex projects with subparsers and custom completions for paths matching
certain patterns (e.g. `--file=*.txt`) are fully supported (see
[examples/customcomplete.py](https://github.com/iterative/shtab/tree/master/examples/customcomplete.py)
[examples/customcomplete.py](https://github.com/iterative/shtab/tree/main/examples/customcomplete.py)
or even
[iterative/dvc:command/completion.py](https://github.com/iterative/dvc/blob/master/dvc/command/completion.py)
[iterative/dvc:commands/completion.py](https://github.com/iterative/dvc/blob/main/dvc/commands/completion.py)
for example).

Add direct support to scripts for a little more configurability:
Expand Down

0 comments on commit 58f1549

Please sign in to comment.