Skip to content

Commit 70ec498

Browse files
authored
Merge branch 'master' into documentation
2 parents a72d84d + 6d7f7a1 commit 70ec498

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/user/transition.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,14 @@ This script will concatenate and print out all of the json objects in a /snippet
9595
in a project. After running the script, copy the output and paste into the User Preferences
9696
panel in settings, similar to the single snippet upload.
9797

98-
**NOTE: If adding objects to existing list of snippets in user preferences, change counter variable to n+1 where n is the ID of the last snippet stored in user preferences.**
98+
**NOTE**: If adding objects to existing list of snippets in user preferences, change *counter* variable
99+
to n+1 where n is the ID of the last snippet stored in user preferences.
99100

100101
This script will print something like :
101102

102103
.. code::
104+
105+
103106
{"snippets": [
104107
105108
{
@@ -134,20 +137,21 @@ This script will print something like :
134137
135138
After generating this dictionary, one can simply delete the current contents of user preferences
136139
(Advanced Settings > Code Snippet Manager > User Preferences) and paste this dictionary instead.
137-
This will delete the current snippets at the endpoint (will be default snippets if extension freshly updated)
138-
and replace them with the old snippets.
140+
This will delete the current snippets at the endpoint (which will be default snippets if the extension is
141+
freshly updated/installed) and replace them with the old snippets.
139142

140-
**NOTE: If adding objects onto an existing list of objects, make sure the ID numbers are all in sequential,
141-
ascending order.**
143+
**NOTE**: If adding objects onto an existing list of objects, make sure the ID numbers are all in sequential,
144+
ascending order.
142145

143146
Search and Tag Update
144147
---------------------
145148

146149
.. image:: ../../Design/smallUnselectedTags.png
147150
:align: center
148151

149-
**NOTE: Snippet tags function on an OR basis, as in when the "data analytics" tag and the "import statements" tag are selected together,
150-
the panel displays any tags that are tagged as import statements OR tagged as "data analytics."**
152+
**NOTE 1**: Snippet tags function on an OR basis, as in when the "data analytics" tag and the "import statements" tag are selected together,
153+
the panel displays any tags that are tagged as import statements OR tagged as "data analytics."
154+
151155
ex) Snippet tags selected together:
152156

153157
.. image:: ../../Design/smallSnippetTagsSelected.png
@@ -158,17 +162,17 @@ ex) Language tags selected together:
158162
.. image:: ../../Design/smallLanguageTagsSelected.png
159163
:align: center
160164

161-
**NOTE 2: Language tags and snippets tags have an AND relationship. As in when the "Python" tag and the "data analytics" tags are selected together,
162-
only snippets that are both in the language Python AND tagged as data analytics will appear.**
165+
**NOTE 2**: Language tags and snippets tags have an AND relationship. As in when the "Python" tag and the "data analytics" tags are selected together,
166+
only snippets that are both in the language Python AND tagged as data analytics will appear.
163167

164168
.. image:: ../../Design/smallLangAndSnippetTag.png
165169
:align: center
166170

167-
**NOTE 3: When language tags are selected, only snippet tags in that language will appear for ease of selection.**
171+
**NOTE 3**: When language tags are selected, only snippet tags in that language will appear for ease of selection.
168172

169173
.. image:: ../../Design/smallPythonTagOnly.png
170174
:align: center
171175

172-
**NOTE 4: If 2 of the same language tags appear in the Language Tags section this indicates that one of the snippets
176+
**NOTE 4**: If 2 of the same language tags appear in the Language Tags section this indicates that one of the snippets
173177
contains a snippet tag that matches the language name. To get rid of the duplicate tag, filter through snippets and
174-
untag any snippets that have that Language in their snippet tags.**
178+
untag any snippets that have that Language in their snippet tags.

0 commit comments

Comments
 (0)