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

📝 Updated documentation #87

Merged
merged 27 commits into from
Dec 12, 2022
Merged

📝 Updated documentation #87

merged 27 commits into from
Dec 12, 2022

Conversation

marcelwa
Copy link
Collaborator

@marcelwa marcelwa commented Dec 9, 2022

This PR prettifies many parts of the documentation, makes use of MathJax where appropriate, and fixes inconsistencies as well as outdated docstrings.

@marcelwa marcelwa added the documentation Documentation is added or needed label Dec 9, 2022
@marcelwa marcelwa self-assigned this Dec 9, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2022

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

@codecov
Copy link

codecov bot commented Dec 9, 2022

Codecov Report

Merging #87 (2212c4b) into main (7c0a843) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 2212c4b differs from pull request most recent head e61a25e. Consider uploading reports for the commit e61a25e to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   93.63%   93.63%           
=======================================
  Files          58       58           
  Lines        6083     6083           
=======================================
  Hits         5696     5696           
  Misses        387      387           
Impacted Files Coverage Δ
...orithms/graph/generate_edge_intersection_graph.hpp 94.66% <ø> (ø)
...nclude/fiction/algorithms/graph/graph_coloring.hpp 96.29% <ø> (ø)
.../fiction/algorithms/iter/aspect_ratio_iterator.hpp 100.00% <ø> (ø)
...hms/network_transformation/fanout_substitution.hpp 98.91% <ø> (ø)
...ithms/network_transformation/network_balancing.hpp 97.18% <ø> (ø)
...thms/network_transformation/network_conversion.hpp 82.25% <ø> (ø)
include/fiction/algorithms/path_finding/cost.hpp 100.00% <ø> (ø)
...clude/fiction/algorithms/path_finding/distance.hpp 100.00% <ø> (ø)
...on/algorithms/path_finding/enumerate_all_paths.hpp 97.72% <ø> (ø)
...tion/algorithms/path_finding/jump_point_search.hpp 98.42% <ø> (ø)
... and 41 more

Continue to review full report at Codecov.

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

@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2022

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

@marcelwa marcelwa merged commit 801ef78 into main Dec 12, 2022
@marcelwa marcelwa deleted the documentation-fixes branch December 12, 2022 14:14
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant