Skip to content

Improve documentation formatting#1068

Merged
alamb merged 1 commit intoapache:mainfrom
alamb:alamb/doc_improvements
Dec 19, 2023
Merged

Improve documentation formatting#1068
alamb merged 1 commit intoapache:mainfrom
alamb:alamb/doc_improvements

Conversation

@alamb
Copy link
Copy Markdown
Contributor

@alamb alamb commented Dec 19, 2023

While reviewing #1059 I noticed the documentation comments leave a lot to be desired in this crate.

While I was waiting for CI to pass, I spent some time making some improvements.

There are plenty more to make, but I think this is a step in the right direction

@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 7267352347

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
To ensure accuracy in future PRs, please see these guidelines.
A quick fix for this PR: rebase it; your next report should be accurate.

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.733%

Totals Coverage Status
Change from base Build 7267336660: 0.0%
Covered Lines: 18187
Relevant Lines: 20730

💛 - Coveralls

@alamb alamb merged commit 40bc407 into apache:main Dec 19, 2023
@alamb alamb deleted the alamb/doc_improvements branch April 9, 2024 20:32
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.

2 participants