Skip to content

Update gyro docs #2294

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

Merged
merged 2 commits into from
Jul 21, 2023
Merged

Update gyro docs #2294

merged 2 commits into from
Jul 21, 2023

Conversation

calcmogul
Copy link
Member

The Gyro interface was deprecated in wpilibsuite/allwpilib#5445.

The Gyro interface was deprecated in wpilibsuite/allwpilib#5445.
@calcmogul
Copy link
Member Author

calcmogul commented Jul 17, 2023

What does this mean (how is the title level inconsistent)? I didn't hit this with the accelerometer changes that were essentially identical.

/home/runner/work/frc-docs/frc-docs/source/docs/software/hardware-apis/sensors/gyros-software.rst:169: CRITICAL: Title level inconsistent:

Example: Tank drive stabilization using turn rate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/home/runner/work/frc-docs/frc-docs/source/docs/software/hardware-apis/sensors/gyros-software.rst:241: CRITICAL: Title level inconsistent:

Example: Tank drive stabilization using heading
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Generating and adding controls javascript...
make: *** [Makefile:35: linkcheck] Error 1
Error: Process completed with exit code 2.

@sciencewhiz
Copy link
Collaborator

https://docs.wpilib.org/en/stable/docs/contributing/frc-docs/style-guide.html#headings

All the individual gyros were heading level 3, and the gyro interface was level 2 but was removed. So now there's no level 2 for the level 3 headings to be under. They should be moved up a level.

@sciencewhiz sciencewhiz added the Waiting On: WPILib Waiting on something from WPILib label Jul 18, 2023
@Daltz333 Daltz333 merged commit 4587402 into wpilibsuite:main Jul 21, 2023
@calcmogul calcmogul deleted the update-gyro-docs branch July 21, 2023 02:28
pjbuterbaugh pushed a commit to pjbuterbaugh/frc-docs that referenced this pull request Jul 25, 2023
* Update gyro docs

The Gyro interface was deprecated in wpilibsuite/allwpilib#5445.

* Fix title levels
guineawheek pushed a commit to guineawheek/frc-docs that referenced this pull request Aug 2, 2023
* Update gyro docs

The Gyro interface was deprecated in wpilibsuite/allwpilib#5445.

* Fix title levels
pjbuterbaugh pushed a commit to pjbuterbaugh/frc-docs that referenced this pull request Sep 17, 2023
* Update gyro docs

The Gyro interface was deprecated in wpilibsuite/allwpilib#5445.

* Fix title levels
pjbuterbaugh pushed a commit to pjbuterbaugh/frc-docs that referenced this pull request Oct 29, 2023
* Update gyro docs

The Gyro interface was deprecated in wpilibsuite/allwpilib#5445.

* Fix title levels
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Waiting On: WPILib Waiting on something from WPILib
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants