Skip to content

Remove dollar signs from code examples #234

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

Merged
merged 1 commit into from
Mar 11, 2021
Merged

Remove dollar signs from code examples #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ search_guide_2: |-
})
getting_started_add_documents_md: |-
```bash
$ pip3 install meilisearch
pip3 install meilisearch
```

```python
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
### Setup <!-- omit in toc -->

```bash
$ pipenv install --dev
pipenv install --dev
```

### Tests and Linter <!-- omit in toc -->
Expand All @@ -38,19 +38,19 @@ Each PR should pass the tests and the linter to be accepted.

```bash
# Tests
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
$ pipenv run pytest meilisearch
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
pipenv run pytest meilisearch
# Linter
$ pipenv run pylint meilisearch
pipenv run pylint meilisearch
```

Optionally tox can be used to run test on all supported version of Python and linting.

```bash
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
$ pipenv run tox
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
pipenv run tox
```

### Want to debug? <!-- omit in toc -->
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta
With `pip3` in command line:

```bash
$ pip3 install meilisearch
pip3 install meilisearch
```

### Run MeiliSearch <!-- omit in toc -->
Expand All @@ -56,8 +56,8 @@ There are many easy ways to [download and run a MeiliSearch instance](https://do
For example, if you use Docker:

```bash
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
```

NB: you can also download MeiliSearch from **Homebrew** or **APT**.
Expand Down