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

📝 Fixed some inconcistencies in the RTD documentation #167

Merged
merged 16 commits into from
Mar 29, 2023

Conversation

marcelwa
Copy link
Collaborator

@marcelwa marcelwa commented Mar 28, 2023

Description

This PR fixes some minor inconsistencies in fiction's documentation.

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

@marcelwa marcelwa added documentation Documentation is added or needed small fix Non-critical issue or inconsistency labels Mar 28, 2023
@marcelwa marcelwa self-assigned this Mar 28, 2023
@codecov
Copy link

codecov bot commented Mar 28, 2023

Codecov Report

Merging #167 (fe8e757) into main (acbe7aa) will increase coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #167      +/-   ##
==========================================
+ Coverage   94.24%   94.25%   +0.01%     
==========================================
  Files          76       76              
  Lines        7070     7070              
==========================================
+ Hits         6663     6664       +1     
+ Misses        407      406       -1     
Impacted Files Coverage Δ
.../fiction/algorithms/iter/aspect_ratio_iterator.hpp 100.00% <ø> (ø)
...n/algorithms/verification/equivalence_checking.hpp 89.79% <ø> (ø)

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update acbe7aa...fe8e757. Read the comment docs.

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

1 similar comment
@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

4 similar comments
@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@github-actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@marcelwa marcelwa merged commit 71f34f5 into main Mar 29, 2023
@marcelwa marcelwa deleted the docu-consistency branch March 29, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation is added or needed small fix Non-critical issue or inconsistency
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant