Falko Schindler 2 years ago
parent
commit
a77e3c6121
2 changed files with 11 additions and 10 deletions
  1. 5 4
      CONTRIBUTING.md
  2. 6 6
      tests/README.md

+ 5 - 4
CONTRIBUTING.md

@@ -33,9 +33,10 @@ This will install the `nicegui` package and all its dependencies, and link it to
 Thereby enabling you to use your local version of NiceGUI in other projects.
 To run the tests you need some additional setup which is described in [tests/README.md](https://github.com/zauberzeug/nicegui/blob/main/tests/README.md).
 
-There is no special Python version required for development. At Zauberzeug we mainly use 3.11.
+There is no special Python version required for development.
+At Zauberzeug we mainly use 3.11.
 This means we sometimes miss some incompatibilities with 3.7.
-But these will hopefully uncovered by the GitHub Actions (see below).
+But these will hopefully be uncovered by the GitHub Actions (see below).
 Also we use the 3.7 Docker container described below to verify compatibility in cases of uncertainty.
 
 ### Alternative: Docker
@@ -49,7 +50,7 @@ Simply start the development container using the command:
 
 By default, the development server listens to http://localhost:80/.
 
-The configuration is written in the `docker-compose.yml` file and automatically loads the `main.py` which is contains the website https://nicegui.io.
+The configuration is written in the `docker-compose.yml` file and automatically loads the `main.py` which contains the website https://nicegui.io.
 Every code change will result in reloading the content.
 We use Python 3.7 as a base to ensure compatibility (see `development.dockerfile`).
 
@@ -74,7 +75,7 @@ Then the formatting rules are applied whenever you save a file.
 
 ## Running tests
 
-Our tests are build with pytest and require python-selenium with Chrome driver.
+Our tests are built with pytest and require python-selenium with ChromeDriver.
 See [tests/README.md](https://github.com/zauberzeug/nicegui/blob/main/tests/README.md) for detailed installation instructions and more infos about the test infrastructure and tricks for daily usage.
 
 Before submitting a pull request, please make sure that all tests are passing.

+ 6 - 6
tests/README.md

@@ -8,7 +8,7 @@ Even if automated testing needs a lot of infrastructure and results in long exec
 
 ## Setup
 
-Please be aware that the below commands installs the latest version of the ChromeDriver binary, which is compatible with the version of Google Chrome installed on your system.
+Please be aware that the below commands install the latest version of the ChromeDriver binary, which is compatible with the version of Google Chrome installed on your system.
 If you have a different version of Chrome installed, you may need to install a different version of ChromeDriver or update your Chrome installation to be compatible with the installed ChromeDriver version.
 
 ### Mac
@@ -48,14 +48,14 @@ Please refer to the documentation for your distribution for more information.
 
 ## Usage
 
-Because selenium queries are quite cumbersome and lengthily, we introduced a `Screen` class.
+Because Selenium queries are quite cumbersome and lengthy, we introduced a `Screen` class.
 This provides a high-level interface to work with the currently displayed state of the web browser.
 The workflow is as follows:
 
-1. get the screen fixture by providing `screen: Screen` as an argument to the function
-2. write your NiceGUI code inside the function
-3. use `screen.open(...)` with the appropriate url path to start querying the website
-4. for example use `screen.should_contain(...)` with some text as parameter to ensure that the text is shown
+1. Get the `screen` fixture by providing `screen: Screen` as an argument to the function.
+2. Write your NiceGUI code inside the function.
+3. Use `screen.open(...)` with the appropriate URL path to start querying the website.
+4. For example, use `screen.should_contain(...)` with some text as parameter to ensure that the text is shown.
 
 Here is a very simple example: