Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Coding style guide #95

Merged
merged 24 commits into from
Dec 19, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs/developers/style-guide.md
Co-authored-by: Torsten Scholak <torsten.scholak@googlemail.com>
  • Loading branch information
jlamypoirier and tscholak authored Dec 18, 2024
commit 42d4e4364bf1dcb335b20f571b4d79b755ba0162
2 changes: 1 addition & 1 deletion docs/developers/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ If an offending import is only required for a type hint, include it in a `if typ
!!! warning "Configuration modules"

tscholak marked this conversation as resolved.
Show resolved Hide resolved
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.
Expand Down
Loading