Skip to content

Commit 36579ca

Browse files
craigfowlerGithub Actions Workflow (bot)
authored andcommitted
Publish updated documentation website
1 parent 3b0a8e9 commit 36579ca

19 files changed

Lines changed: 984 additions & 107 deletions

docs/api/CSF.Screenplay.ReportModel.ActorCreatedReport.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ <h1 id="CSF_Screenplay_ReportModel_ActorCreatedReport" data-uid="CSF.Screenplay.
128128
<div>
129129
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
130130
</div>
131+
<div>
132+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>
133+
</div>
131134
<div>
132135
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
133136
</div>

docs/api/CSF.Screenplay.ReportModel.ActorGainedAbilityReport.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,9 @@ <h1 id="CSF_Screenplay_ReportModel_ActorGainedAbilityReport" data-uid="CSF.Scree
129129
<div>
130130
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
131131
</div>
132+
<div>
133+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>
134+
</div>
132135
<div>
133136
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
134137
</div>

docs/api/CSF.Screenplay.ReportModel.ActorSpotlitReport.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ <h1 id="CSF_Screenplay_ReportModel_ActorSpotlitReport" data-uid="CSF.Screenplay.
128128
<div>
129129
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
130130
</div>
131+
<div>
132+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>
133+
</div>
131134
<div>
132135
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
133136
</div>

docs/api/CSF.Screenplay.ReportModel.PerformableReport.html

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ <h1 id="CSF_Screenplay_ReportModel_PerformableReport" data-uid="CSF.Screenplay.R
128128
<div>
129129
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
130130
</div>
131+
<div>
132+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>
133+
</div>
131134
<div>
132135
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
133136
</div>
@@ -171,7 +174,7 @@ <h2 class="section" id="properties">Properties
171174

172175
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_Assets" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Assets">
173176
Assets
174-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L98"><i class="bi bi-code-slash"></i></a>
177+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L116"><i class="bi bi-code-slash"></i></a>
175178
</h3>
176179

177180
<div class="markdown level1 summary"><p>Gets or sets a collection of the assets which were recorded by the current performable.</p>
@@ -199,11 +202,61 @@ <h4 class="section">Property Value</h4>
199202

200203

201204

205+
<a id="CSF_Screenplay_ReportModel_PerformableReport_Ended_" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Ended*"></a>
206+
207+
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_Ended" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Ended">
208+
Ended
209+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L54"><i class="bi bi-code-slash"></i></a>
210+
</h3>
211+
212+
<div class="markdown level1 summary"><p>Gets or sets the relative time at which this performable ended/finished.</p>
213+
</div>
214+
<div class="markdown level1 conceptual"></div>
215+
216+
<div class="codewrapper">
217+
<pre><code class="lang-csharp hljs">public TimeSpan Ended { get; set; }</code></pre>
218+
</div>
219+
220+
221+
222+
223+
224+
<h4 class="section">Property Value</h4>
225+
<dl class="parameters">
226+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
227+
<dd></dd>
228+
</dl>
229+
230+
231+
232+
233+
<h4 class="section" id="CSF_Screenplay_ReportModel_PerformableReport_Ended_remarks">Remarks</h4>
234+
<div class="markdown level1 remarks"><p>
235+
This property is expressed as an amount of time since the Screenplay began. The beginning of the Screenplay is recorded in the
236+
report metadata, at <a class="xref" href="CSF.Screenplay.ReportModel.ReportMetadata.html#CSF_Screenplay_ReportModel_ReportMetadata_Timestamp">Timestamp</a>.
237+
</p>
238+
<p>
239+
Recall that it is quite normal for performances and thus reportable actions to occur in parallel.
240+
Do not be alarmed if it appears that unrelated performances are interleaved with regard to their timings.
241+
</p>
242+
</div>
243+
244+
245+
<dl class="typelist seealso">
246+
<dt>See Also</dt>
247+
<dd>
248+
<div><a class="xref" href="CSF.Screenplay.ReportModel.ReportMetadata.html#CSF_Screenplay_ReportModel_ReportMetadata_Timestamp">Timestamp</a></div>
249+
<div><a class="xref" href="CSF.Screenplay.ReportModel.PerformanceReport.html#CSF_Screenplay_ReportModel_PerformanceReport_Started">Started</a></div>
250+
<div><a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">Started</a></div>
251+
</dd>
252+
</dl>
253+
254+
202255
<a id="CSF_Screenplay_ReportModel_PerformableReport_Exception_" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Exception*"></a>
203256

204257
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_Exception" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Exception">
205258
Exception
206-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L75"><i class="bi bi-code-slash"></i></a>
259+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L93"><i class="bi bi-code-slash"></i></a>
207260
</h3>
208261

209262
<div class="markdown level1 summary"><p>Gets or sets a value which is the string representation of any <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a> which occurred, causing
@@ -243,7 +296,7 @@ <h4 class="section" id="CSF_Screenplay_ReportModel_PerformableReport_Exception_r
243296

244297
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_ExceptionIsFromConsumedPerformable" data-uid="CSF.Screenplay.ReportModel.PerformableReport.ExceptionIsFromConsumedPerformable">
245298
ExceptionIsFromConsumedPerformable
246-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L93"><i class="bi bi-code-slash"></i></a>
299+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L111"><i class="bi bi-code-slash"></i></a>
247300
</h3>
248301

249302
<div class="markdown level1 summary"><p>Gets a value which indicates whether or not the <a class="xref" href="CSF.Screenplay.ReportModel.PerformableReport.html#CSF_Screenplay_ReportModel_PerformableReport_Exception">Exception</a> is one which was originally thrown from a consumed performable.</p>
@@ -288,7 +341,7 @@ <h4 class="section" id="CSF_Screenplay_ReportModel_PerformableReport_ExceptionIs
288341

289342
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_HasResult" data-uid="CSF.Screenplay.ReportModel.PerformableReport.HasResult">
290343
HasResult
291-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L62"><i class="bi bi-code-slash"></i></a>
344+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L80"><i class="bi bi-code-slash"></i></a>
292345
</h3>
293346

294347
<div class="markdown level1 summary"><p>Gets or sets a value that indicates whether or not the performable (which generated this report) emitted a result.</p>
@@ -404,7 +457,7 @@ <h4 class="section" id="CSF_Screenplay_ReportModel_PerformableReport_Performance
404457

405458
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_Reportables" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Reportables">
406459
Reportables
407-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L115"><i class="bi bi-code-slash"></i></a>
460+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L133"><i class="bi bi-code-slash"></i></a>
408461
</h3>
409462

410463
<div class="markdown level1 summary"><p>Gets or sets a collection of the reportable items which have been composed by the current performable.</p>
@@ -444,7 +497,7 @@ <h4 class="section" id="CSF_Screenplay_ReportModel_PerformableReport_Reportables
444497

445498
<h3 id="CSF_Screenplay_ReportModel_PerformableReport_Result" data-uid="CSF.Screenplay.ReportModel.PerformableReport.Result">
446499
Result
447-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L49"><i class="bi bi-code-slash"></i></a>
500+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableReport.cs/#L67"><i class="bi bi-code-slash"></i></a>
448501
</h3>
449502

450503
<div class="markdown level1 summary"><p>Gets or sets a string representation of the result which was emitted by the corresponding performable.</p>

docs/api/CSF.Screenplay.ReportModel.PerformanceReport.html

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,56 @@ <h4 class="section">Property Value</h4>
268268

269269

270270

271+
<a id="CSF_Screenplay_ReportModel_PerformanceReport_Started_" data-uid="CSF.Screenplay.ReportModel.PerformanceReport.Started*"></a>
272+
273+
<h3 id="CSF_Screenplay_ReportModel_PerformanceReport_Started" data-uid="CSF.Screenplay.ReportModel.PerformanceReport.Started">
274+
Started
275+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformanceReport.cs/#L72"><i class="bi bi-code-slash"></i></a>
276+
</h3>
277+
278+
<div class="markdown level1 summary"><p>Gets or sets the time at which this performance was begun.</p>
279+
</div>
280+
<div class="markdown level1 conceptual"></div>
281+
282+
<div class="codewrapper">
283+
<pre><code class="lang-csharp hljs">public TimeSpan Started { get; set; }</code></pre>
284+
</div>
285+
286+
287+
288+
289+
290+
<h4 class="section">Property Value</h4>
291+
<dl class="parameters">
292+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
293+
<dd></dd>
294+
</dl>
295+
296+
297+
298+
299+
<h4 class="section" id="CSF_Screenplay_ReportModel_PerformanceReport_Started_remarks">Remarks</h4>
300+
<div class="markdown level1 remarks"><p>
301+
This property is expressed as an amount of time since the Screenplay began. The beginning of the Screenplay is recorded in the
302+
report metadata, at <a class="xref" href="CSF.Screenplay.ReportModel.ReportMetadata.html#CSF_Screenplay_ReportModel_ReportMetadata_Timestamp">Timestamp</a>.
303+
</p>
304+
<p>
305+
Recall that it is quite normal for performances and thus reportable actions to occur in parallel.
306+
Do not be alarmed if it appears that unrelated performances are interleaved with regard to their timings.
307+
</p>
308+
</div>
309+
310+
311+
<dl class="typelist seealso">
312+
<dt>See Also</dt>
313+
<dd>
314+
<div><a class="xref" href="CSF.Screenplay.ReportModel.ReportMetadata.html#CSF_Screenplay_ReportModel_ReportMetadata_Timestamp">Timestamp</a></div>
315+
<div><a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">Started</a></div>
316+
<div><a class="xref" href="CSF.Screenplay.ReportModel.PerformableReport.html#CSF_Screenplay_ReportModel_PerformableReport_Ended">Ended</a></div>
317+
</dd>
318+
</dl>
319+
320+
271321

272322
</article>
273323

docs/api/CSF.Screenplay.ReportModel.ReportMetadata.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2 class="section" id="properties">Properties
157157

158158
<h3 id="CSF_Screenplay_ReportModel_ReportMetadata_ReportFormatVersion" data-uid="CSF.Screenplay.ReportModel.ReportMetadata.ReportFormatVersion">
159159
ReportFormatVersion
160-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/ReportMetadata.cs/#L26"><i class="bi bi-code-slash"></i></a>
160+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/ReportMetadata.cs/#L31"><i class="bi bi-code-slash"></i></a>
161161
</h3>
162162

163163
<div class="markdown level1 summary"><p>Gets or sets a version number for the format of report that has been produced.</p>
@@ -195,15 +195,15 @@ <h4 class="section" id="CSF_Screenplay_ReportModel_ReportMetadata_ReportFormatVe
195195

196196
<h3 id="CSF_Screenplay_ReportModel_ReportMetadata_Timestamp" data-uid="CSF.Screenplay.ReportModel.ReportMetadata.Timestamp">
197197
Timestamp
198-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/ReportMetadata.cs/#L15"><i class="bi bi-code-slash"></i></a>
198+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/ReportMetadata.cs/#L20"><i class="bi bi-code-slash"></i></a>
199199
</h3>
200200

201-
<div class="markdown level1 summary"><p>Gets or sets the UTC timestamp at which the report was generated.</p>
201+
<div class="markdown level1 summary"><p>Gets or sets the date &amp; time at which the Screenplay began.</p>
202202
</div>
203203
<div class="markdown level1 conceptual"></div>
204204

205205
<div class="codewrapper">
206-
<pre><code class="lang-csharp hljs">public DateTime Timestamp { get; set; }</code></pre>
206+
<pre><code class="lang-csharp hljs">public DateTimeOffset Timestamp { get; set; }</code></pre>
207207
</div>
208208

209209

@@ -212,13 +212,18 @@ <h3 id="CSF_Screenplay_ReportModel_ReportMetadata_Timestamp" data-uid="CSF.Scree
212212

213213
<h4 class="section">Property Value</h4>
214214
<dl class="parameters">
215-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetime">DateTime</a></dt>
215+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
216216
<dd></dd>
217217
</dl>
218218

219219

220220

221221

222+
<h4 class="section" id="CSF_Screenplay_ReportModel_ReportMetadata_Timestamp_remarks">Remarks</h4>
223+
<div class="markdown level1 remarks"><p>
224+
Other time-related values within the Screenplay report are expressed relative to this time.
225+
</p>
226+
</div>
222227

223228

224229

0 commit comments

Comments
 (0)