Address comments

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
mlflow · Feb 20, 2024 · a6dcdba · a6dcdba
1 parent 7253e9f
commit a6dcdba
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -32,8 +32,8 @@ repos:
         stages: [commit]
         require_serial: true
 
-      - id: clint
-        name: clint
+      - id: custom-python-lint
+        name: custom-python-lint
         entry: clint
         language: system
         types: [python]

diff --git a/dev/clint/README.md b/dev/clint/README.md
@@ -1,16 +1,20 @@
-# Installation
+# Clint
+
+A custom linter for mlflow to enforce rules that ruff doesn't cover.
+
+## Installation
 
 ```
 pip install -e dev/clint
 ```
 
-# Usage
+## Usage
 
 ```bash
 clint file.py ...
 ```
 
-# Integrating with Visual Studio Code
+## Integrating with Visual Studio Code
 
 1. Install [the Pylint extension](https://marketplace.visualstudio.com/items?itemName=ms-python.pylint)
 2. Add the following setting in your `settings.json` file:

diff --git a/dev/clint/pyproject.toml b/dev/clint/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "clint"
 version = "0.1.0"
-description = "A custom linter to enforce rules that ruff doesn't support."
+description = "A custom linter for mlflow to enforce rules that ruff doesn't cover."
 readme = "README.md"
 authors = [{ name = "mlflow", email = "mlflow@mlflow.com" }]
 dependencies = ["tomli"]