Skip to content

Commit

Permalink
Fix lexer name for bash
Browse files Browse the repository at this point in the history
  • Loading branch information
Tims777 committed Feb 14, 2024
1 parent 6b4d559 commit 8a6abfb
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 27 deletions.
6 changes: 3 additions & 3 deletions Documentation/Build-Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ fill in all values with the corresponding secrets.
To create the virtual environment in this project you must have `pipenv`
installed on your machine. Then run the following commands:

```[bash]
```bash
# for development environment
pipenv install --dev
# for production environment
Expand All @@ -22,7 +22,7 @@ pipenv install

To work within the environment you can now run:

```[bash]
```bash
# to activate the virtual environment
pipenv shell
# to run a single command
Expand Down Expand Up @@ -55,6 +55,6 @@ To run the application the `pipenv` environment must be installed and all needed
environment variables must be set in the `.env` file. Then the application can
be started via

```[bash]
```bash
pipenv run python src/main.py
```
12 changes: 6 additions & 6 deletions Documentation/Contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ The stable branches `main` and `dev` are protected against direct pushes. To com

Before contributing to this repository make sure that you are identifiable in your git user settings. This way commits and PRs created by you can be identified and easily traced back.

```[bash]
```bash
git config --local user.name "Manu Musterperson"
git config --local user.email "[email protected]"
```

Any commit should always contain a commit message that references an issue created in the project. Also, always signoff on your commits for identification reasons.

```[bash]
```bash
git commit -m "Fixed issue #123" --signoff
```

When doing pair programming be sure to always have all SDs mentioned in the commit message. Each SD should be listed on a new line for clarity reasons.

```[bash]
```bash
git commit -a -m "Fixed problem #123
> Co-authored-by: Manu Musterperson <[email protected]>" --signoff
```
Expand All @@ -50,7 +50,7 @@ Here is a standard way to merge pull requests:

1. Have all your local changes added, committed, and pushed on the remote **feature-1** branch

```[bash]
```bash
git checkout feature-1
git add .
git commit -m "added a feature" --signoff # don't forget the signoff ;)
Expand All @@ -59,7 +59,7 @@ Here is a standard way to merge pull requests:

2. Make sure your local main branch up-to-date

```[bash]
```bash
git checkout main
git pull main
```
Expand All @@ -78,7 +78,7 @@ _**In case of merge conflict:**_
Should we experience merge conflict after step 3, we should solve the merge conflicts manually, below the title of "This branch has conflicts that must be resolved" click on web editor (you can use vscode or any editor you want).
The conflict should look like this:

```[bash]
```bash
<<<<<<< HEAD
// Your changes at **feature-1** branch
=======
Expand Down
6 changes: 3 additions & 3 deletions Documentation/Miscellaneous.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This file contains content that was moved over from our [Wiki](https://github.co

## Pre-commit:

```[bash]
```bash
# If not installed yet
pip install pre-commit

Expand Down Expand Up @@ -147,7 +147,7 @@ AI models needed that solve a regression or probability problem

#### install stuck

```[bash]
```bash
pipenv install –dev
```

Expand All @@ -168,7 +168,7 @@ Terminal can't run docker image (on windows)
don't analyze a certain part of the code with reuse
**Solution**:

```[bash]
```bash
# REUSE-IgnoreStart
...
# REUSE-IgnoreEnd
Expand Down
12 changes: 6 additions & 6 deletions Documentation/User-Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To execute the final program, ensure the environment is installed (refer to
build-documents.md) and run `python .\src\main.py` either locally or via the
build process. The user will be presented with the following options:

```[bash]
```bash
Choose demo:
(0) : Base Data Collector
(1) : Data preprocessing
Expand All @@ -41,7 +41,7 @@ Configuration options are presented:

`Do you want to list all available pipeline configs? (y/N)` If `y`:

```[bash]
```bash
Please enter the index of requested pipeline config:
(0) : config_sprint09_release.json
(1) : just_run_search_offeneregister.json
Expand All @@ -57,7 +57,7 @@ Please enter the index of requested pipeline config:
If `n`: proceed to pipeline step selection for data enrichment. Subsequent
questions arise:

```[bash]
```bash
Run Scrape Address (will take a long time)(y/N)?
Run Search OffeneRegister (will take a long time)(y/N)?
Run Phone Number Validation (y/N)?
Expand Down Expand Up @@ -127,7 +127,7 @@ preprocessed_data is stored.

Six machine learning models are available:

```[bash]
```bash
(0) : Random Forest
(1) : XGBoost
(2) : Naive Bayes
Expand All @@ -147,7 +147,7 @@ prompted with a series of questions:
instead of the 5 classes. It is worth noting that grouping the S, M and L
classes alltogether as one class resulted in boosting the classification
performance.
- ```[bash]
- ```bash
Do you want to train on a subset of features?
(0) : ['Include all features']
(1) : ['google_places_rating', 'google_places_user_ratings_total', 'google_places_confidence', 'regional_atlas_regional_score']
Expand All @@ -159,7 +159,7 @@ learning models

Then, the user would be given multiple options:

```[bash]
```bash
(1) Train
(2) Test
(3) Predict on single lead
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The repository contains the file `.env.template`. This file is a template for th

To create the virtual environment in this project you must have `pipenv` installed on your machine. Then run the following commands:

```[bash]
```bash
# for development environment
pipenv install --dev
# for production environment
Expand All @@ -29,7 +29,7 @@ pipenv install

To work within the environment you can now run:

```[bash]
```bash
# to activate the virtual environment
pipenv shell
# to run a single command
Expand All @@ -38,7 +38,7 @@ pipenv run <COMMAND>

To install new packages in the environment add them to the `Pipfile`. Always pin the exact package version to avoid package conflicts and unexpected side effects from package upgrades.

```[bash]
```bash
# to add a package to the development environment
[dev-packages]
<PACKAGE_NAME> = "==<VERSION_NUMBER>"
Expand All @@ -57,27 +57,27 @@ This application is run using a Docker container. For this the `Dockerfile` at r

To build the application run

```[bash]
```bash
./build_app.sh
```

To run the application interactively run

```[bash]
```bash
./run_app.sh
```

## Database Connection

To build the Docker containers

```[bash]
```bash
docker-compose build
```

To run the Docker containers

```[bash]
```bash
docker-compose run sumup_app
```

Expand All @@ -87,7 +87,7 @@ This project is operated under an MIT license. Every file must contain the REUSE

[REUSE documentation](https://reuse.software/faq/)

```[bash]
```bash
# SPDX-License-Identifier: MIT
# SPDX-FileCopyrightText: 2023
```
Expand All @@ -96,7 +96,7 @@ This project is operated under an MIT license. Every file must contain the REUSE

This repository uses `pre-commit` hooks to ensure a consistent and clean file organization. Each registered hook will be executed when committing to the repository. To ensure that the hooks will be executed they need to be installed using the following command:

```[bash]
```bash
pre-commit install
```

Expand Down

0 comments on commit 8a6abfb

Please sign in to comment.