Skip to content

Commit d7cc6c4

Browse files
committed
docs: update documentation
Signed-off-by: Jack Cherng <jfcherng@gmail.com>
1 parent fe9b59a commit d7cc6c4

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ST-AutoSetSyntax
22

3-
[![Required ST Build](https://img.shields.io/badge/ST-4201+-orange.svg?style=flat-square&logo=sublime-text)](https://www.sublimetext.com)
3+
[![Required ST Build](https://img.shields.io/badge/ST-4203+-orange.svg?style=flat-square&logo=sublime-text)](https://www.sublimetext.com)
44
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/jfcherng-sublime/ST-AutoSetSyntax/python.yml?branch=st4&style=flat-square)](https://github.com/jfcherng-sublime/ST-AutoSetSyntax/actions)
55
[![Package Control](https://img.shields.io/packagecontrol/dt/AutoSetSyntax?style=flat-square)](https://packagecontrol.io/packages/AutoSetSyntax)
66
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/jfcherng-sublime/ST-AutoSetSyntax?style=flat-square&logo=github)](https://github.com/jfcherng-sublime/ST-AutoSetSyntax/tags)

docs/src/dl-based-syntax-detection.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,15 @@ It uses Google's [Magika](https://github.com/google/magika) library to detect th
1010

1111
## Prerequisites
1212

13-
1. If you are using MacOS, MacOS 11 (Big Sur) or later is required.
13+
1. If you are using MacOS, MacOS 14 (Arm64) or later is required.
1414
You can run `$ sw_vers` in terminal to check the OS version.
15-
1. If you are using Linux, GLIBC 2.27 or later is required.
15+
1. If you are using Linux, GLIBC 2.28 or later is required.
1616
You can run `$ ldd --version` in terminal to check the GLIBC version on your system.
1717

1818
1. Install dependencies.
1919

2020
Run `AutoSetSyntax: Download Dependencies` from the command palette.
21-
The dependencies is about 15\~25 MB in size, so it may take a while.
22-
When it's done, there will be a popup dialogue.
21+
Downloading dependencies may take a while and when it's done, there will be a popup dialogue.
2322

2423
!!! tip "If your machine has no access to GitHub..."
2524

@@ -37,7 +36,7 @@ It uses Google's [Magika](https://github.com/google/magika) library to detect th
3736
```text
3837
Package Storage
3938
└─ AutoSetSyntax
40-
└─ libs-py38@linux_x64
39+
└─ libs-py314@linux_x64
4140
├── click
4241
├── click-8.1.7.dist-info
4342
├── colorama

plugin/logger.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ def _create_log_panel(window: sublime.Window) -> sublime.View:
4747

4848

4949
class Logger:
50+
"""This class is used to create/manage a per-window log panel for this plugin."""
51+
5052
DELIMITER: Final[str] = "-" * 10
5153
SYNTAX_FILE: Final[str] = f"Packages/{PLUGIN_NAME}/syntaxes/AutoSetSyntaxLog.sublime-syntax"
5254

0 commit comments

Comments
 (0)