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

add type hints to Medium class and other improvements and fixes to docs #2554

Merged
merged 3 commits into from
Jun 21, 2023

Conversation

oskooi
Copy link
Collaborator

@oskooi oskooi commented Jun 20, 2023

Fixes #2539.

Various improvements and fixes to the docs including:

  • add type hints for the Medium class
  • mention version requirement for autograd dependency for adjoint solver
  • fix or remove several broken links in one of the FAQs
  • use consistent formatting for the type declarations
  • use # as the anchor link (introduced in Add anchor links to section headers in mkdocs manual #2550)

@oskooi oskooi changed the title Improvements and fixes to docs add type hints to Medium class and other improvements and fixes to docs Jun 20, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #2554 (1d959bb) into master (37516cf) will decrease coverage by 0.42%.
The diff coverage is 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master    #2554      +/-   ##
==========================================
- Coverage   73.91%   73.49%   -0.42%     
==========================================
  Files          18       18              
  Lines        5294     5294              
==========================================
- Hits         3913     3891      -22     
- Misses       1381     1403      +22     
Impacted Files Coverage Δ
python/simulation.py 77.06% <ø> (ø)
python/geom.py 90.37% <100.00%> (-3.79%) ⬇️

@oskooi oskooi requested a review from smartalecH June 20, 2023 13:13
@oskooi oskooi merged commit 57aee78 into NanoComp:master Jun 21, 2023
@oskooi oskooi deleted the docs_jun19 branch June 21, 2023 04:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

test_adjoint_solver.py failing due to autograd-related error
2 participants