Skip to content

misc: split database and added docs#267

Merged
baszalmstra merged 1 commit intomun-lang:masterfrom
baszalmstra:misc/cleanup_and_docs
Sep 12, 2020
Merged

misc: split database and added docs#267
baszalmstra merged 1 commit intomun-lang:masterfrom
baszalmstra:misc/cleanup_and_docs

Conversation

@baszalmstra
Copy link
Collaborator

@baszalmstra baszalmstra commented Sep 12, 2020

It required some effort to understand the codebase so I thought it was time to add a bunch of documentation. I also split some of the databases into different databases to get a better grouping.

@baszalmstra baszalmstra added the type: docs Improvements or additions to documentation label Sep 12, 2020
@baszalmstra baszalmstra requested a review from Wodann September 12, 2020 11:34
@baszalmstra baszalmstra self-assigned this Sep 12, 2020
@codecov
Copy link

codecov bot commented Sep 12, 2020

Codecov Report

Merging #267 into master will decrease coverage by 0.03%.
The diff coverage is 33.33%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #267      +/-   ##
==========================================
- Coverage   79.08%   79.05%   -0.04%     
==========================================
  Files         214      214              
  Lines       12803    12808       +5     
==========================================
  Hits        10125    10125              
- Misses       2678     2683       +5     
Impacted Files Coverage Δ
crates/mun_codegen/src/mock.rs 82.05% <0.00%> (-4.44%) ⬇️
crates/mun_compiler/src/db.rs 47.05% <0.00%> (-6.28%) ⬇️
crates/mun_compiler/src/driver.rs 59.76% <ø> (ø)
crates/mun_hir/src/expr/validator/tests.rs 100.00% <ø> (ø)
crates/mun_hir/src/mock.rs 85.71% <0.00%> (-5.20%) ⬇️
crates/mun_hir/src/ty/tests.rs 96.51% <ø> (ø)
crates/mun_language_server/src/db.rs 10.71% <0.00%> (-0.83%) ⬇️
crates/mun_language_server/src/diagnostics.rs 0.00% <ø> (ø)
crates/mun_hir/src/db.rs 100.00% <100.00%> (ø)
crates/mun_hir/src/in_file.rs 45.45% <100.00%> (ø)
... and 1 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 e330f15...996dd4f. Read the comment docs.

Copy link
Collaborator

@Wodann Wodann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to have this documentation, and the code is also a lot more concise. Thanks for this!

How did you make the diagram? I like the style! 🙂

@baszalmstra
Copy link
Collaborator Author

How did you make the diagram? I like the style! 🙂

It's basically draw.io with a custom font: https://drawio-app.com/introducing-draw-ios-new-sketch-feature/
The font is: https://fonts.google.com/specimen/Indie+Flower

@baszalmstra baszalmstra merged commit 04821da into mun-lang:master Sep 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants