Skip to content

Commit 8b9f3d3

Browse files
committed
formatting changes & added credits
1 parent 0b44a6a commit 8b9f3d3

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

tutorial.md

+20-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Tutorial
22

3-
I needed a way to list [codetags](https://www.python.org/dev/peps/pep-0350/) in
4-
my project. While
3+
I was looking for a way to standardize the creation of comments in my projects
4+
and came across [codetags](https://www.python.org/dev/peps/pep-0350/).
55
[vscode-codetags](https://marketplace.visualstudio.com/items?itemName=cg-cnu.vscode-codetags)
6-
lets you standardizing the creation of tags you can use the extensions below to
7-
add more value to it. This guide initially written by [Théry
6+
is my attempt at scratching that itch. This addon helps you standardize the
7+
creation of tags. But there is a lot of value you can gain by combining with
8+
other extenstions. This guide, initially written by [Théry
89
Fouchter](https://github.com/TheryFouchter) helps you setup and list codetags
9-
with Icons and color per codetag.
10+
with Icons and colors.
1011

1112
## Screenshot
1213

@@ -18,9 +19,12 @@ You can use the below addons and its settings to create a set of custom todos
1819
and display them in the Todo Tree and assign specific color using better
1920
comments. Add the below configurations to settings.json
2021

22+
By unifying the tags, icons and colors across all the addons you get a
23+
seamless experience.
24+
2125
### Code Tags
2226

23-
You can extend tags in Code Tags by
27+
You can extend tags in codetags by defining your own custom tags.
2428

2529
```json
2630
// Add additional codetags
@@ -66,7 +70,8 @@ You can extend tags in Code Tags by
6670
Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)
6771
by [Gruntfuggly](https://marketplace.visualstudio.com/publishers/Gruntfuggly)
6872
lets you display all the TODOs in your project. Its an amazing addon and it can
69-
be extended to track codetags.
73+
be extended to track codetags. You define the codetags you are using and specify
74+
the color and icon per tag.
7075

7176
```json
7277
// (recommended) only highlight the tag due to the regex bellow
@@ -163,7 +168,8 @@ be extended to track codetags.
163168
[Better
164169
Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
165170
by [Aaron Bond](https://marketplace.visualstudio.com/publishers/aaron-bond)
166-
makes your comments beautify. You can configure it to work with codetags.
171+
makes your comments more meaningful. You can configure it to work with codetags by
172+
setting different color for each codetag.
167173

168174
```json
169175
// The color of the line of your codetags
@@ -284,3 +290,9 @@ makes your comments beautify. You can configure it to work with codetags.
284290
}
285291
]
286292
```
293+
294+
## Credits
295+
296+
- 👏 [Théry Fouchter](https://github.com/TheryFouchter)
297+
- 👏 [Aaron Bond](https://marketplace.visualstudio.com/publishers/aaron-bond)
298+
- 👏 [Gruntfuggly](https://marketplace.visualstudio.com/publishers/Gruntfuggly)

0 commit comments

Comments
 (0)