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

Doc test readme #830

Merged
merged 9 commits into from
Jun 22, 2022
Merged

Doc test readme #830

merged 9 commits into from
Jun 22, 2022

Conversation

hepengfe
Copy link
Collaborator

@hepengfe hepengfe commented Jun 8, 2022

This PR fixes #829.

Description of changes

  • change TerminalReader to StringReader
  • fixed the issue Doctest for README #829 (comment)
  • add package mkcodes that convert markdown code into python script
  • generate python script based on latest README, test it and remove it after testing

Possible influences of this PR.

Describe what are the possible side-effects of the code change.

Test Conducted

Describe what test cases are included for the PR.

@hepengfe hepengfe added bug Something isn't working topic: examples Issue about examples test_cases labels Jun 8, 2022
@hepengfe hepengfe self-assigned this Jun 8, 2022
@codecov
Copy link

codecov bot commented Jun 8, 2022

Codecov Report

Merging #830 (ed96565) into master (ac34f10) will not change coverage.
The diff coverage is n/a.

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

@@           Coverage Diff           @@
##           master     #830   +/-   ##
=======================================
  Coverage   80.50%   80.50%           
=======================================
  Files         252      252           
  Lines       19363    19363           
=======================================
  Hits        15588    15588           
  Misses       3775     3775           

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 ac34f10...f9e7bed. Read the comment docs.

@hepengfe hepengfe requested a review from mylibrar June 9, 2022 18:33
@hepengfe hepengfe marked this pull request as ready for review June 9, 2022 18:33
mylibrar
mylibrar previously approved these changes Jun 10, 2022
@mylibrar mylibrar dismissed their stale review June 10, 2022 18:56

Need to update the test-markdown conversion

@hunterhector
Copy link
Member

I find markdown autodoc to be a better alternative. Instead of extracting code from a markdown (which is a bit hacky), we just need to add a tested piece of code into the README.

README.md Outdated Show resolved Hide resolved
@hepengfe hepengfe merged commit 3ed661e into asyml:master Jun 22, 2022
@hepengfe hepengfe deleted the doc_test_readme branch June 22, 2022 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working test_cases topic: examples Issue about examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doctest for README
3 participants