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 missing dev docs #64

Merged
merged 4 commits into from
Apr 4, 2022
Merged

Add missing dev docs #64

merged 4 commits into from
Apr 4, 2022

Conversation

Saransh-cpp
Copy link
Owner

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • Package installs: julia> ]dev .
  • All tests pass: julia> ]test ChaoticEncryption
  • The documentation builds: $ cd docs and then $ julia make.jl

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Acknowledgements

This Pull Request template was taken from the excellent PyBaMM repository.

@Saransh-cpp Saransh-cpp added the documentation Improvements or additions to documentation label Apr 4, 2022
@Saransh-cpp Saransh-cpp added this to the v0.3.0 milestone Apr 4, 2022
@codecov
Copy link

codecov bot commented Apr 4, 2022

Codecov Report

Merging #64 (2c3484d) into master (b94f312) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 2c3484d differs from pull request most recent head 7c9663f. Consider uploading reports for the commit 7c9663f to get more accurate results

@@            Coverage Diff            @@
##            master       #64   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           70        57   -13     
=========================================
- Hits            70        57   -13     
Impacted Files Coverage Δ
src/substitution.jl 100.00% <100.00%> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@Saransh-cpp Saransh-cpp merged commit 3dc41e3 into master Apr 4, 2022
@Saransh-cpp Saransh-cpp deleted the add-doc-versions branch April 4, 2022 16:45
@Saransh-cpp Saransh-cpp mentioned this pull request Apr 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant