Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update characterrange.rst #41

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/general/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Array of ``GpuAccelType`` enums, or null if no viewers are open; read-only. One
- ``SOFTWARE``

**Example**

The following sample code checks the current computer's available GPU acceleration types, and sets it to Metal if available.

.. code:: javascript
Expand Down
2 changes: 1 addition & 1 deletion docs/general/globals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Global functions
################

These globally available functions that are specific to After Effects. Any JavaScript object or function can call these functions, which allow you to display text in a small (3-line) area of the Info panel, to convert numeric time values to and from string values, or to generate a random number.
These globally available functions are specific to After Effects. Any JavaScript object or function can call these functions, which allow you to display text in a small (3-line) area of the Info panel, to convert numeric time values to and from string values, or to generate a random number.


========================== ===================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/classhierarchy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
After Effects Class Hierarchy
#############################

This section lists the class hierarchies for relevant AE API elements. For a primer on what this means, see :ref:`Javascript.Classes`
This section lists the class hierarchies for relevant AE API elements. For a primer on what this means, see :ref:`Javascript.Classes`.

When using this guide, any objects that exist as part of a class hierarchy will note whether they exist as a subclass or base class (or both) of another object.

Expand Down
4 changes: 2 additions & 2 deletions docs/other/preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ The Preferences object provides an easy way to manage internal AE preferences, s

Preferences are identified by section and key within the file, and each key name is associated with a value.

In the preferences file, section names are enclosed in brackets and quotation marks, and key names are listing in quotation marks below the sectionname. All values are strings.
johnkenneth99 marked this conversation as resolved.
Show resolved Hide resolved
In the preferences file, section names are enclosed in brackets and quotation marks, and key names are listed in quotation marks below the section name. All values are strings.

You can create new preferences with this object, as well as accessing existing preferences.
You can create new preferences with this object, as well as access existing preferences.

As of Version 12/CC, preferences and settings methods now take a third argument to specify the target preferences file if Section/Key is not in "Adobe After Effects $versionNumber.x Prefs.txt".

Expand Down
4 changes: 2 additions & 2 deletions docs/other/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ The Settings object provides an easy way to manage settings for third-party scri

Settings are identified by section and key within the file, and each key name is associated with a value.

In the settings file, section names are enclosed in brackets and quotation marks, and key names are listing in quotation marks below the sectionname. All values are strings.
In the settings file, section names are enclosed in brackets and quotation marks, and key names are listed in quotation marks below the section name. All values are strings.

You can create new settings with this object, as well as accessing existing settings.
You can create new settings with this object, as well as access existing settings.

As of Version 12/CC, preferences and settings methods now take a third argument to specify the target preferences file if Section/Key is not in the main preferences file. See :ref:`Preferences` for more info.

Expand Down
2 changes: 1 addition & 1 deletion docs/text/paragraphrange.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The ParagraphRange object is an accessor to a paragraph range of the :ref:`TextD

- The :ref:`characterStart<ParagraphRange.characterStart>` attribute will report the first character index of the range.
- The :ref:`characterEnd<ParagraphRange.characterEnd>` attribute will report the (last + 1) character index of the range, such that (:ref:`characterEnd<ParagraphRange.characterEnd>` - :ref:`characterStart<ParagraphRange.characterStart>`) represents the number of characters in the range.
- The only time these two properties will equal will on an empty last paragraph of the :ref:`TextDocument`.
- The only time these two properties will equal is on an empty last paragraph of the :ref:`TextDocument`.

When accessed, the ParagraphRange object will check that effective :ref:`characterStart<ParagraphRange.characterStart>` and effective :ref:`characterEnd<ParagraphRange.characterEnd>` of the range remains valid for the current span of the related :ref:`TextDocument`. This is the same rule as applied when the ParagraphRange was created, but because the length of the related :ref:`TextDocument` can change through the addition or removal of characters, the effective :ref:`characterStart<ParagraphRange.characterStart>` and effective :ref:`characterEnd<ParagraphRange.characterEnd>` may no longer be valid. In this situation an exception will be thrown on access, either read or write. The :ref:`isRangeValid<ParagraphRange.isRangeValid>` attribute will return false if the effective range is no longer valid.

Expand Down