Skip to content

Commit 0ab9870

Browse files
authored
Merge pull request Sofie-Automation#1527 from rjmunro/rjmunro/fix-typos
Fix typos
2 parents 69c0465 + 6d6f639 commit 0ab9870

File tree

60 files changed

+398
-378
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+398
-378
lines changed

_typos.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[default]
2+
extend-ignore-identifiers-re = [
3+
# Short Git hashes contained in square brackets
4+
"[a-f0-9]{7}",
5+
]
6+
7+
# [default.extend-identifiers]
8+
# # *sigh* this just isn't worth the cost of fixing
9+
# AttributeIDSupressMenu = "AttributeIDSupressMenu"
10+
11+
[default.extend-words]
12+
ndi = "ndi"
13+
nd = "nd"
14+
anc = "anc"
15+
nexting = "nexting"
16+
loggin = "loggin"
17+
18+
19+
[files]
20+
extend-exclude = ["packages/documentation/versioned_docs", "packages/webui/public/locales", "*.po"]

meteor/CHANGELOG.md

Lines changed: 157 additions & 157 deletions
Large diffs are not rendered by default.

meteor/CHANGELOG_0_x_x.md

Lines changed: 129 additions & 129 deletions
Large diffs are not rendered by default.

meteor/server/api/playout/DOCS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before any playout operation can proceed a studio and playlist lock must be crea
2020
- Check that no other rundown playlist in the studio is active
2121
- Reset the rundown if previously inactive
2222
- Set activationId and rehearsal mode on the playlist
23-
- If there is no currenly active partInstance, set the first part as next
23+
- If there is no currently active partInstance, set the first part as next
2424
- Update the timeline
2525
- Call the blueprints `onRundownActive` callback
2626

@@ -147,7 +147,7 @@ _Prerequisites for activate: active playlist, current part, next part and hold s
147147
- Set the playlist hold state to PENDING
148148
- Update the timeline
149149

150-
_Prerequisites for deactive: hold state is Pending_
150+
_Prerequisites for deactivate: hold state is Pending_
151151

152152
- Set the playlist hold state to NONE
153153
- Update the timeline

packages/blueprints-integration/CHANGELOG-legacy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ All notable changes to this project will be documented in this file. See [standa
242242
### Features
243243

244244
- expose infinite ids of pieces to onTimelineGenerate ([401f30d](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/401f30d))
245-
- persistant state to onTimelineGenerate ([713c048](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/713c048))
245+
- persistent state to onTimelineGenerate ([713c048](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/713c048))
246246

247247
## [0.24.0](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/compare/0.23.0...0.24.0) (2019-06-18)
248248

@@ -296,7 +296,7 @@ All notable changes to this project will be documented in this file. See [standa
296296

297297
### Features
298298

299-
- Refacor sli and adlib types ([e6fc888](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/e6fc888))
299+
- Refactor sli and adlib types ([e6fc888](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/e6fc888))
300300
- Refactor typings for simpler ingest gateway interface ([5edd6e5](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/5edd6e5))
301301
- rename everything according to new naming schedule ([54268c5](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/54268c5))
302302
- split some types into simpler ones ([0a7fb06](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/0a7fb06))
@@ -539,7 +539,7 @@ All notable changes to this project will be documented in this file. See [standa
539539

540540
### Bug Fixes
541541

542-
- **rundown:** Correct types of transisition duration properties on Part ([b0aec50](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/b0aec50))
542+
- **rundown:** Correct types of transition duration properties on Part ([b0aec50](https://github.com/nrkno/tv-automation-sofie-blueprints-integration/commit/b0aec50))
543543

544544
<a name="0.4.0"></a>
545545

packages/documentation/docs/for-developers/data-model.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In every case, any layout changes and any scheduled cleanup are performed by the
1818

1919
This category of collections is rather loosely defined, as it ends up being everything that doesn't belong somewhere else
2020

21-
This consists of anything that is configurable from the Sofie UI, anything needed soley for the UI and some other bits. Additionally, there are some collections which are populated by other portions of a Sofie system, such as by Package Manager, through an API over DDP.
21+
This consists of anything that is configurable from the Sofie UI, anything needed solely for the UI and some other bits. Additionally, there are some collections which are populated by other portions of a Sofie system, such as by Package Manager, through an API over DDP.
2222
Currently, there is not a very clearly defined flow for modifying these documents, with the UI often making changes directly with minimal or no validation.
2323

2424
This includes:
@@ -81,7 +81,7 @@ Some of these collections are used by Package Manager to initiate work, while ot
8181

8282
This category of collections is owned by the playout [worker threads](./worker-threads-and-locks.md), and is used to model the playout of a Rundown or set of Rundowns.
8383

84-
During the final stage of an ingest operation, there is a period where the ingest worker aquires a `PlaylistLock`, so that it can ensure that the RundownPlaylist the Rundown is a part of is updated with any necessary changes following the ingest operation. During this lock, it will also attempt to [sync any ingest changes](./for-blueprint-developers/sync-ingest-changes) to the PartInstances and PieceInstances, if supported by the blueprints.
84+
During the final stage of an ingest operation, there is a period where the ingest worker acquires a `PlaylistLock`, so that it can ensure that the RundownPlaylist the Rundown is a part of is updated with any necessary changes following the ingest operation. During this lock, it will also attempt to [sync any ingest changes](./for-blueprint-developers/sync-ingest-changes) to the PartInstances and PieceInstances, if supported by the blueprints.
8585

8686
As before, Meteor is allowed to write to these collections as part of migrations, and cleaning up old documents.
8787

@@ -100,7 +100,7 @@ These collections are used in combination with many of the ingest collections, t
100100
RundownPlaylists are a Sofie invention designed to solve one problem; in some NRCS it is beneficial to build a show across multiple Rundowns, which should then be concatenated for playout.
101101
In particular, MOS has no concept of a Playlist, only Rundowns, and it was here where we need to be able to combine multiple Rundowns.
102102

103-
This functionality can be used to either break down long shows into managable chunks, or to indicate a different type of show between the each portion.
103+
This functionality can be used to either break down long shows into manageable chunks, or to indicate a different type of show between the each portion.
104104

105105
Because of this, RundownPlaylists are largely missing from the ingest side of Sofie. We do not expose them in the ingest APIs, or do anything with them throughout the majority of the blueprints generating a Rundown.
106106
Instead, we let the blueprints specify that a Rundown should be part of a RundownPlaylist by setting the `playlistExternalId` property, where multiple Rundowns in a Studio with the same id will be grouped into a RundownPlaylist.
@@ -126,6 +126,6 @@ Our solution to some of this early on was to not regenerate certain Parts when r
126126

127127
At this point in time, Adlib Actions did not exist in Sofie. They are able to change almost every property of a Part of Piece that ingest is able to define, which makes the resetting process harder.
128128

129-
PartInstances and PieceInstances were added as a way for us to make a copy of each Part and Piece, as it was selected for playout, so that we could allow ingest without risking affecting playout, and to simplify the cleanup performed. The PartInstances and PieceInstances are our record of how the Rundown was played, which we can utilise to output metadata such as for chapter markers on a web player. In earlier versions of Sofie this was tracked independently with an `AsRunLog`, which resulted in odd issues such as having `AsRunLog` entries which refered to a Part which no longer existed, or whose content was very different to how it was played.
129+
PartInstances and PieceInstances were added as a way for us to make a copy of each Part and Piece, as it was selected for playout, so that we could allow ingest without risking affecting playout, and to simplify the cleanup performed. The PartInstances and PieceInstances are our record of how the Rundown was played, which we can utilise to output metadata such as for chapter markers on a web player. In earlier versions of Sofie this was tracked independently with an `AsRunLog`, which resulted in odd issues such as having `AsRunLog` entries which referred to a Part which no longer existed, or whose content was very different to how it was played.
130130

131131
Later on, this separation has allowed us to more cleanly define operations as ingest or playout, and allows us to run them in parallel with more confidence that they won't accidentally wipe out each others changes. Previously, both ingest and playout operations would be modifying documents in the Piece and Part collections, making concurrent operations unsafe as they could be modifying the same Part or Piece.

packages/documentation/docs/for-developers/device-integrations/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
Device integrations in Sofie are part of the Timeline State Resolver (TSR) library. A device integration has a couple of responsibilites in the Sofie eco system. First and foremost it should establish a connection with a foreign device. It should also be able to convert Sofie's idea of what the device should be doing into commands to control the device. And lastly it should export interfaces to be used by the blueprints developer.
3+
Device integrations in Sofie are part of the Timeline State Resolver (TSR) library. A device integration has a couple of responsibilities in the Sofie eco system. First and foremost it should establish a connection with a foreign device. It should also be able to convert Sofie's idea of what the device should be doing into commands to control the device. And lastly it should export interfaces to be used by the blueprints developer.
44

55
In order to understand all about writing TSR integrations there are some concepts to familiarise yourself with, in this documentation we will attempt to explain these.
66

@@ -9,9 +9,9 @@ In order to understand all about writing TSR integrations there are some concept
99
- [TSR Types package](./tsr-types.html)
1010
- [TSR Actions](./tsr-actions.html)
1111

12-
But to start of we will explain the general structure of the TSR. Any user of the TSR will interface primarily with the Conductor class. Primarily the user will input device configurations, mappings and timelines into the TSR. The timeline describes the entire state of all of the devices over time. It does this by putting objects on timeline layers. Every timeline layer maps to a specific part of the device, this is configured throught the mappings.
12+
But to start off we will explain the general structure of the TSR. Any user of the TSR will interface primarily with the Conductor class. Primarily the user will input device configurations, mappings and timelines into the TSR. The timeline describes the entire state of all of the devices over time. It does this by putting objects on timeline layers. Every timeline layer maps to a specific part of the device, this is configured through the mappings.
1313

14-
The timeline is converted into disctinct states at different points in time, and these states are fed to the individual integrations. As an integration developer you shouldn't have to worry about keeping track of this. It is most important that you expose \(a\) a method to convert from a Timeline State to a Device State, \(b\) a method for diffing 2 device states and (c) a way to send commands to the device. We'll dive deeper into this in [TSR Integration API](./tsr-api.html).
14+
The timeline is converted into disctinct states at different points in time, and these states are fed to the individual integrations. As an integration developer you shouldn't have to worry about keeping track of this. It is most important that you expose \(a\) a method to convert from a Timeline State to a Device State, \(b\) a method for diffing 2 device states and \(c\) a way to send commands to the device. We'll dive deeper into this in [TSR Integration API](./tsr-api.html).
1515

1616
:::info
1717
The information in this section is not a conclusive guide on writing an integration, it should be use more as a guide to use while looking at a TSR integration such as the [OSC integration](https://github.com/Sofie-Automation/sofie-timeline-state-resolver/tree/master/packages/timeline-state-resolver/src/integrations/osc).

packages/documentation/docs/for-developers/for-blueprint-developers/lookahead.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export enum LookaheadMode {
3838
}
3939
```
4040

41-
If undefined, `lookaheadMaxSearchDistance` currently has a default distance of 10 parts. This number was chosen arbitrarily, and could change in the future. Be careful when choosing a distance to not set it too high. All the Pieces from the parts being searched have to be loaded from the database, which can come at a noticable cost.
41+
If undefined, `lookaheadMaxSearchDistance` currently has a default distance of 10 parts. This number was chosen arbitrarily, and could change in the future. Be careful when choosing a distance to not set it too high. All the Pieces from the parts being searched have to be loaded from the database, which can come at a noticeable cost.
4242

4343
If you are doing [AB Playback](./ab-playback.md), or performing some other processing of the timeline in `onTimelineGenerate`, you may benefit from increasing the value of `lookaheadDepth`. In the case of AB Playback, you will likely want to set it to the number of players available in your pool.
4444

packages/documentation/docs/for-developers/for-blueprint-developers/manipulating-ingest-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ At times it can be useful to manipulate this data before it gets passed into the
77

88
A new method `processIngestData` was added to transform the `NRCSIngestRundown` into a `SofieIngestRundown`. The types of the two are the same, so implementing the `processIngestData` method is optional, with the default being to pass through the NRCS rundown unchanged. (There is an exception here for MOS, which is explained below).
99

10-
The basic implementation of this method which simply propogates nrcs changes is:
10+
The basic implementation of this method which simply propagates nrcs changes is:
1111

1212
```ts
1313
function processIngestData(

packages/documentation/docs/for-developers/for-blueprint-developers/part-and-piece-timings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ const inTransition = {
131131

132132
Pieces with an infinite lifespan (ie, not `lifespan: PieceLifespan.WithinPart`) get handled differently to other pieces.
133133

134-
Only one pieceGoup is created for an infinite Piece which is present in multiple of the current, next and previous Parts.
134+
Only one pieceGroup is created for an infinite Piece which is present in multiple of the current, next and previous Parts.
135135
The Piece calculates and tracks its own started playback times, which is preserved and reused in future takes. On the timeline it lives outside of the partGroups, but still gets the same caps applied when appropriate.
136136

137137
### Interactive timings demo

0 commit comments

Comments
 (0)