From 8a6abfb05ed13c9f8eb1ab7c64fff63b7cdb86ce Mon Sep 17 00:00:00 2001 From: Tims777 Date: Wed, 14 Feb 2024 11:48:31 +0100 Subject: [PATCH] Fix lexer name for bash --- Documentation/Build-Documentation.md | 6 +++--- Documentation/Contribution.md | 12 ++++++------ Documentation/Miscellaneous.md | 6 +++--- Documentation/User-Documentation.md | 12 ++++++------ README.md | 18 +++++++++--------- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/Documentation/Build-Documentation.md b/Documentation/Build-Documentation.md index 0f5628c..c92a1b5 100644 --- a/Documentation/Build-Documentation.md +++ b/Documentation/Build-Documentation.md @@ -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 @@ -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 @@ -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 ``` diff --git a/Documentation/Contribution.md b/Documentation/Contribution.md index de4308c..b54b6d5 100644 --- a/Documentation/Contribution.md +++ b/Documentation/Contribution.md @@ -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 "manu@musterperson.org" ``` 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 " --signoff ``` @@ -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 ;) @@ -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 ``` @@ -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 ======= diff --git a/Documentation/Miscellaneous.md b/Documentation/Miscellaneous.md index 8a61015..1a123a4 100644 --- a/Documentation/Miscellaneous.md +++ b/Documentation/Miscellaneous.md @@ -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 @@ -147,7 +147,7 @@ AI models needed that solve a regression or probability problem #### install stuck -```[bash] +```bash pipenv install –dev ``` @@ -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 diff --git a/Documentation/User-Documentation.md b/Documentation/User-Documentation.md index 54bc3ac..f07efe5 100644 --- a/Documentation/User-Documentation.md +++ b/Documentation/User-Documentation.md @@ -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 @@ -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 @@ -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)? @@ -127,7 +127,7 @@ preprocessed_data is stored. Six machine learning models are available: -```[bash] +```bash (0) : Random Forest (1) : XGBoost (2) : Naive Bayes @@ -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'] @@ -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 diff --git a/README.md b/README.md index 39a44fa..ccbf998 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -38,7 +38,7 @@ pipenv run 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] = "==" @@ -57,13 +57,13 @@ 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 ``` @@ -71,13 +71,13 @@ To run the application interactively run To build the Docker containers -```[bash] +```bash docker-compose build ``` To run the Docker containers -```[bash] +```bash docker-compose run sumup_app ``` @@ -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 ``` @@ -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 ```