Skip to content

README's training section has ill-formatted numbered list and ineffective text highlighting #871

@DvrkRain

Description

@DvrkRain

Problem: In the training section numbered list failed to render correctly. And also, text highlighting is very difficult due to confusing selection

aibolit/README.md

Lines 279 to 290 in c8a8d91

Please notice, that if you set `TARGET_FOLDER`, your dataset files will be
in `TARGET_FOLDER/target`.
That is why it is necessary to
set HOME_TRAIN_DATASET=`TARGET_FOLDER`\target\08\08-train.csv,
HOME_TEST_DATASET =`TARGET_FOLDER`\target\08\08-test.csv
7. If you need to set up own directory where model will be saved, set up also
`SAVE_MODEL_FOLDER` environment variable.
Otherwise model will be saved into
`cloned_aibolit_path/aibolit/binary_files/model.pkl`
8. If you need to set up own folder with Java files, use `--java_folder
parameter`, the default value will be `scripts/target/01` of aibolit cloned
repo

Actual render (text):
"""
Please notice, that if you set TARGET_FOLDER, your dataset files will be in TARGET_FOLDER/target. That is why it is necessary to set
HOME_TRAIN_DATASET=TARGET_FOLDER\target\08\08-train.csv, HOME_TEST_DATASET =TARGET_FOLDER\target\08\08-test.csv 7. If you need to
set up own directory where model will be saved, set up also SAVE_MODEL_FOLDER environment variable. Otherwise model will be saved into
cloned_aibolit_path/aibolit/binary_files/model.pkl 8. If you need to set up own folder with Java files, use --java_folder parameter, the
default value will be scripts/target/01 of aibolit cloned repo
"""
Actual render (image):
Image

Suggestion (Numbered List): Create spaces between text or put part of text at some point in numbered list
Suggestion (Text Highlighting): Highlight all environment variables, including name and value. Use Windows (set and display) or Linux (set and display) style of taking environment variables

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workinggood first issueGood for newcomersgood-titleThe title was checked by ChatGPThelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions