Skip to content

Commit 2340a43

Browse files
authored
More README updates (#200)
- Use deferred links to improve readability. - Fix broken documentation links. - Explain `ViewStream` before `OutputPanel`. - Replace mentions of a "syntax submodule" with "Syntax Utilities".
1 parent f899fb9 commit 2340a43

File tree

1 file changed

+36
-14
lines changed

1 file changed

+36
-14
lines changed

README.md

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# sublime_lib
22

3-
A utility library for Sublime Text,
3+
A utility library for Sublime Text,
44
providing a variety of convenience features.
55

66
## Installation
77

88
To make use of sublime_lib in a package...
99

10-
1. declare it as [dependency](https://packagecontrol.io/docs/dependencies):
10+
1. declare it as [a dependency][pc-dependencies]:
1111

1212
Create a file named `dependencies.json`
1313
with the following contents in package's root directory:
@@ -25,7 +25,7 @@ To make use of sublime_lib in a package...
2525
Open _Command Palette_ and run `Package Control: Satisfy Libraries`
2626
to ensure sublime_lib is installed and available for use.
2727

28-
2. Import sublime_lib in plugins, which want to make use of it.
28+
2. Import sublime_lib in plugins which want to make use of it.
2929

3030
```python
3131
import sublime_lib
@@ -34,28 +34,50 @@ To make use of sublime_lib in a package...
3434
## Features
3535

3636
For complete documentation of all features,
37-
see the [API documentation](https://sublimetext.github.io/sublime_lib/).
37+
see the [API documentation][docs].
3838

3939
Highlights include:
4040

41-
- [`ActivityIndicator`](https://sublimetext.github.io/sublime_lib/#activity-indicator) context manager to indicate background activity via status bar.
42-
- [`ResourcePath`](https://sublimetext.github.io/sublime_lib/#sublime_lib.ResourcePath), a [pathlib.Path](https://docs.python.org/3/library/pathlib.html) inspired representation of ST's resource paths,
41+
- [`ActivityIndicator`][sublime_lib.ActivityIndicator] context manager
42+
to indicate background activity via status bar.
43+
- [`ResourcePath`][sublime_lib.ResourcePath],
44+
a [pathlib.Path][]-inspired representation of ST's resource paths
4345
with methods to convert from and to filesystem paths.
44-
- [`SettingsDict`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.settings_dict.html) provides a standard Python `dict` inspired interface for `sublime.Settings` objects.
45-
- [`OutputPanel`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.output_panel.html), extending `ViewStream` to provide additional functionality for output panel views.
46-
- [`ViewStream`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.view_stream.html), a standard [Python IO stream](https://docs.python.org/3/library/io.html#io.TextIOBase) wrapping a `sublime.View` object
46+
- [`SettingsDict`][sublime_lib.SettingsDict] provides a standard Python `dict`-like interface
47+
for `sublime.Settings` objects.
48+
- [`ViewStream`][sublime_lib.ViewStream],
49+
providing a standard [Python IO stream][io.TextIOBase]
50+
wrapping a `sublime.View` object.
51+
- [`OutputPanel`][sublime_lib.OutputPanel],
52+
extending `ViewStream` to provide additional functionality for output panel views.
4753

4854
### Deprecated
4955

50-
The [`flags` submodule](https://sublimetext.github.io/sublime_lib/#module-sublime_lib.flags) is deprecated in favour of native API, available as of ST4135.
56+
The [`flags` submodule][sublime_lib.flags] is deprecated
57+
in favour of native API,
58+
available as of ST4135.
5159

52-
The [`syntax` submodule](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.syntax.html), is marked deprecated in favour of native API functions, available as of ST4.
60+
The [Syntax Utilities][] are marked deprecated
61+
in favour of native API functions,
62+
available as of ST4.
5363

5464
## Releasing a new version
5565

5666
1. Create a tag in the format `v<major>.<minor>.<patch>`
5767
2. Push the tag to origin.
5868

59-
A GitHub action should be created that builds a WHEEL file,
60-
creates a release for this tag
61-
and attaches the WHEEL file as an artefact.
69+
A GitHub action builds a WHEEL file,
70+
creates a release for this tag,
71+
and attaches the WHEEL file as an artifact.
72+
73+
[docs]: https://sublimetext.github.io/sublime_lib/
74+
[io.TextIOBase]: https://docs.python.org/3/library/io.html#io.TextIOBase
75+
[pathlib.Path]: https://docs.python.org/3/library/pathlib.html
76+
[pc-dependencies]: https://packagecontrol.io/docs/dependencies
77+
[sublime_lib.ActivityIndicator]: https://sublimetext.github.io/sublime_lib/#sublime_lib.ActivityIndicator
78+
[sublime_lib.flags]: https://sublimetext.github.io/sublime_lib/#module-sublime_lib.flags
79+
[sublime_lib.OutputPanel]: https://sublimetext.github.io/sublime_lib/#sublime_lib.OutputPanel
80+
[sublime_lib.ResourcePath]: https://sublimetext.github.io/sublime_lib/#sublime_lib.ResourcePath
81+
[sublime_lib.SettingsDict]: https://sublimetext.github.io/sublime_lib/#sublime_lib.SettingsDict
82+
[sublime_lib.ViewStream]: https://sublimetext.github.io/sublime_lib/#sublime_lib.ViewStream
83+
[Syntax Utilities]: https://sublimetext.github.io/sublime_lib/#syntax-utilities

0 commit comments

Comments
 (0)