From 42d4e4364bf1dcb335b20f571b4d79b755ba0162 Mon Sep 17 00:00:00 2001 From: Joel Lamy-Poirier Date: Wed, 18 Dec 2024 15:03:48 -0500 Subject: [PATCH] Update docs/developers/style-guide.md Co-authored-by: Torsten Scholak --- docs/developers/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/style-guide.md b/docs/developers/style-guide.md index 3365dd8..37d3d1d 100644 --- a/docs/developers/style-guide.md +++ b/docs/developers/style-guide.md @@ -63,7 +63,7 @@ If an offending import is only required for a type hint, include it in a `if typ !!! warning "Configuration modules" Fast-LLM supports instantiation and validation of configurations with a barebone installation. - Because of this, modules that contain configuration classes (usually names `config.py`) + Because of this, modules that contain configuration classes (usually named `config.py`) should not include any top-level third-party import (except for those installed in the [barebone install](https://github.com/ServiceNow/Fast-LLM/blob/main/setup.cfg)), and the same applies for configuration initialization and validation methods. Third-party import may be included in other methods if needed.