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

Updated README.rst to include how to do the setup #555

Closed
wants to merge 7 commits into from
Closed

Updated README.rst to include how to do the setup #555

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4f3025
Updated README.rst to include how to do the setup
za May 25, 2022
40b9c8f
Updated formatting using rst format
za May 26, 2022
c3f71d7
Used :: for commands
za May 26, 2022
1c5f100
Merge branch 'main' into add-setup-info
za Jul 18, 2022
1df188e
Add highlight shell
za Jul 18, 2022
663947c
Merge branch 'main' into add-setup-info
za Sep 6, 2022
912deb3
Merge branch 'main' into add-setup-info
ezio-melotti Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,29 @@ If a Python core developer approved a PR made by anyone and added the "🤖 auto
it will be automatically merged once all the CI checks pass.


Setup Info
==========
Comment on lines +44 to +45
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is really about running tests, let's name it to reflect this.


Requires Python 3.6+
za marked this conversation as resolved.
Show resolved Hide resolved

Comment on lines +49 to +50
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not repeat this info from line 15:

Suggested change
Requires Python 3.6+

It's probably out of date: since #657 we only test 3.11+ so should match that.

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file uses rst instead of MarkDown. See https://devguide.python.org/documenting/#showing-code-examples

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ezio-melotti can I use shell? for the codeblock?

.. code-block:: shell

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I've updated to use ::.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://pygments.org/docs/lexers/#lexers-for-various-shells shell is accepted, otherwise you can use bash or sh too. See also the .. highlight:: directive as suggested in the review.

$ python3 -m venv venv
$ source venv/bin/activate

// for development
ezio-melotti marked this conversation as resolved.
Show resolved Hide resolved
(venv) $ pip install -r dev-requirements.txt

// for production
(venv) $ pip install -r dev-requirements.txt
za marked this conversation as resolved.
Show resolved Hide resolved

```

Run the test code:
```
(venv) $ pytest

```

**Aside**: where does the name come from?
=========================================

Expand Down