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 outdated configuration options in documentation #290

Merged

Conversation

SeanBryan51
Copy link
Collaborator

Fixes #269

@SeanBryan51 SeanBryan51 linked an issue May 6, 2024 that may be closed by this pull request
Copy link

codecov bot commented May 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.97%. Comparing base (59910ed) to head (bb0ab3d).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #290      +/-   ##
==========================================
- Coverage   72.81%   69.97%   -2.84%     
==========================================
  Files          18       18              
  Lines         982      986       +4     
==========================================
- Hits          715      690      -25     
- Misses        267      296      +29     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SeanBryan51
Copy link
Collaborator Author

Preview link for documentation: https://benchcab--290.org.readthedocs.build/en/290/

@SeanBryan51 SeanBryan51 requested review from a team and Whyborn and removed request for a team May 6, 2024 11:39
@ccarouge
Copy link
Collaborator

ccarouge commented May 6, 2024

I've just seen this. While you are at it, would you mind correcting the last line in the repo description:

### [repo](#repo)

Contains settings to specify the CABLE branch to test against. 

This key is _required_. The `repo` key must specify either the [`svn`](#+repo.svn) key or the [`git`](#+repo.git) key.

With:

This key is _required_. The `repo` key must specify the [`svn`](#+repo.svn), the [`git`](#+repo.git) or the [`local`](#+repo.local) key.

@SeanBryan51 SeanBryan51 merged commit 75cfa3d into main May 7, 2024
3 of 4 checks passed
@SeanBryan51 SeanBryan51 deleted the 269-docs-for-configuration-options-are-out-of-date branch May 7, 2024 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Examples in the docs for configuration options are out of date
3 participants