Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 33f4e39

Browse files
committed
fix docs
1 parent 3b6647b commit 33f4e39

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,22 @@ It integrates the following tools:
2626
- which verifies all the things that CI does
2727
- If you use VSCode, it will run black, flake8, isort and mypy on save
2828

29-
The the related ``skeleton`` repo skeleton_ for this module contains the source
29+
The the related skeleton_ repo for this module contains the source
3030
code that can be merged into new or existing projects, and pulled from to
3131
keep them up to date. It can also serve as a working example for those who
3232
would prefer to cherry-pick.
3333

3434
.. _skeleton: https://github.com/epics-containers/python3-pip-skeleton
3535

36-
This ``cli`` repo contains the
36+
This ``python3-pip-skeleton-cli`` repo contains the
3737
docs and a command line tool to ease the adoption of this skeleton into a
3838
new project like this::
3939

40-
python3-pip-skeleton new /path/to/be/created
40+
python3-pip-skeleton new /path/to/be/created --org my_github_user_or_org
4141

4242
and existing projects::
4343

44-
python3-pip-skeleton existing /path/to/existing/repo
44+
python3-pip-skeleton existing /path/to/existing/repo --org my_github_user_or_org
4545

4646
.. |code_ci| image:: https://github.com/epics-containers/python3-pip-skeleton/workflows/Code%20CI/badge.svg?branch=main
4747
:target: https://github.com/epics-containers/python3-pip-skeleton/actions?query=workflow%3A%22Code+CI%22

docs/tutorials/new.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Creating a new repo from the skeleton
44
Once you have followed the `installation` tutorial, you can use the
55
commandline tool to make a new repo that inherits the skeleton::
66

7-
python3-pip-skeleton new /path/to/be/created
7+
python3-pip-skeleton new /path/to/be/created --org my_github_user_or_org
88

99
This will:
1010

@@ -49,9 +49,6 @@ run this, there will be some failing tests::
4949
FAILED tests/test_boilerplate_removed.py::test_changed_README_body - AssertionError: Please change ./README.rst to include some features and why people should use it
5050
FAILED tests/test_boilerplate_removed.py::test_removed_CHANGELOG_note - AssertionError: Please change ./CHANGELOG.rst To remove the note at the top
5151
FAILED tests/test_boilerplate_removed.py::test_changed_CHANGELOG - AssertionError: Please change ./CHANGELOG.rst To summarize changes to your module as you make them
52-
FAILED tests/test_boilerplate_removed.py::test_docs_ref_api_changed - AssertionError: Please change ./docs/reference/api.rst to introduce the API for your module
53-
FAILED tests/test_boilerplate_removed.py::test_how_tos_written - AssertionError: Please delete ./docs/how-to/accomplish-a-task.rst and write some docs/how-tos
54-
FAILED tests/test_boilerplate_removed.py::test_explanations_written - AssertionError: Please delete ./docs/explanations/why-is-something-so.rst and write some docs/explanations
5552
========================================================================== 8 failed, 5 passed in 0.28s ==========================================================================
5653

5754
When you change the template text mentioned in the error, these tests will pass.

0 commit comments

Comments
 (0)