Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Handle invalid bookmarks during builds
Browse files Browse the repository at this point in the history
- Changed log severity from warning to suggestion
- Added `Devices` property category
- Capitalized sentence start
bparks13 committed Sep 9, 2024
1 parent 6801090 commit e941da3
Showing 5 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -75,7 +75,7 @@ git submodule update --recursive --remote
The following three commands are run remotely by remote GitHub Actions serve upon pushing to a branch. The branch will not be able to merge to main unless all three commands complete successfully without any errors. Confirm that they can complete successfully without errors locally before committing and pushing. Otherwise, the branch becomes cluttered with potentially several attempts to pass the link-check process. Run:

``` console
.\build.ps1 --logLevel Warning --warningsAsErrors
.\build.ps1 --logLevel Suggestion --warningsAsErrors
dotnet DocLinkChecker -v -f .github/workflows/DocLinkChecker.config
```

4 changes: 3 additions & 1 deletion articles/getting-started/property-categories.md
Original file line number Diff line number Diff line change
@@ -7,4 +7,6 @@ There are specific categories of properties that define when an operator's prope

`Configuration` properties only have effect when a workflow is started and are used to initialize the hardware state. If they are changed while a workflow is running they will have no effect.

`Acquisition` properties can be manipulated when the workflow is running and will have an immediate effect on hardware. For instance stimulus waveform parameters can be modified in real-time and sent to the device multiple times while the workflow is running to shape stimulation patterns.
`Acquisition` properties can be manipulated when the workflow is running and will have an immediate effect on hardware. For instance stimulus waveform parameters can be modified in real-time and sent to the device multiple times while the workflow is running to shape stimulation patterns.

`Devices` properties refer to the individual devices available within a particular aggregate operator. Aggregate operators include <xref:OpenEphys.Onix1.ConfigureHeadstage64>, <xref:OpenEphys.Onix1.BreakoutBoard>, and more. Explore other available options under the [aggregate configuration operators](xref:configure) page.
8 changes: 4 additions & 4 deletions articles/hubs/onix1-breakout/configuration.md
Original file line number Diff line number Diff line change
@@ -12,10 +12,10 @@ This above configuration graph creates a context (an object that interfaces with


- The [`BreakoutBoard`](xref:OpenEphys.Onix1.ConfigureBreakoutBoard) operator is set to configure the Onix1 Breakout to:
- stream digital IO and analog IO data
- set analog pin 0 as output and the rest as input
- accept ±10V analog inputs range
- stream heartbeat and memory usage data at 10Hz
- Stream digital IO and analog IO data
- Set analog pin 0 as output and the rest as input
- Accept ±10V analog inputs range
- Stream heartbeat and memory usage data at 10Hz
- The above bullet point is accomplished by changing the following properties from their default values:
- The `BreakoutBoard`'s `AnalogIO Direction0` property is set to `Output`.
- The `BreakoutBoard`'s `MemoryMonitor Enable` property is set to `True`.
2 changes: 1 addition & 1 deletion docfx-utils.ps1
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ function removeartifacts
Write-Output ""
}

function build{.\build.ps1 --logLevel Warning --warningsAsErrors}
function build{.\build.ps1 --logLevel Suggestion --warningsAsErrors}

function linkcheck
{
3 changes: 3 additions & 0 deletions docfx.json
Original file line number Diff line number Diff line change
@@ -67,5 +67,8 @@
"https://horizongir.github.io/opencv.net/xrefmap.yml",
"https://horizongir.github.io/reactive/xrefmap.yml"
]
},
"rules": {
"InvalidBookmark": "suggestion"
}
}

0 comments on commit e941da3

Please sign in to comment.