Conversation
This commit introduces a new Styling Guide to the project documentation. The guide (`docs/styling_guide.md`) is generated based on an analysis of the project's existing linter (Pylint) and formatter (Black) configurations (`pylintrc`, `pyproject.toml`) as well as Mypy settings. It summarizes key conventions, including: - Code formatting with Black (100-char line length). - Naming conventions (snake_case, PascalCase, etc.). - Indentation (4 spaces) and line endings (LF). - Docstring expectations. - Type checking enforcement with Mypy. The new guide has been linked from the Contributing page (`docs/contributing.md`) and added to the site navigation in `mkdocs.yml`.
This commit applies several targeted adjustments to the documentation
based on user feedback:
- Styling Guide: Rolled back the recent addition of the styling guide.
- `docs/styling_guide.md` is not included.
- References in `docs/contributing.md` and `mkdocs.yml` removed.
- `docs/contributing.md` retains earlier improvements regarding
Black/Pylint mentions and `grip` usage.
- `docs/cookbook.md`:
- Reverted the section heading concerning logging configuration
back to "Using `fileConfig`" and adjusted its description.
- `docs/index.md`:
- Ensured heading levels are consistent with the original structure.
- Removed a specific clarifying comment from a code example.
- `docs/quickstart.md`:
- Uncommented an example line related to default logging fields.
- `mkdocs.yml`:
- Restored the `literate-nav` plugin configuration to its previous state.
These changes fine-tune the documentation improvements and remove the
recently added styling guide components.
Removes the comment line "# Expected output:" from the code example in `docs/index.md` for conciseness.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Various minor fixes as suggested by jules.google