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

Ensure tested example code in readme #219

Open
geekq opened this issue Aug 2, 2019 · 0 comments
Open

Ensure tested example code in readme #219

geekq opened this issue Aug 2, 2019 · 0 comments

Comments

@geekq
Copy link
Owner

geekq commented Aug 2, 2019

Will fix problems like #194

  1. implement preprocessing asciidoctor files using using https://libraries.io/rubygems/asciidoctor-reducer as mentioned in https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74?permalink_comment_id=3431647#gistcomment-3431647
    to work around missing support for includes in GitHub and possible Yard/Rubydocs
  2. extract source code snippets from README to separate test files and include them back via asciidoctor
  3. ensure github links like gh-229 Port CI from travis-CI to GitHub actions #229 work
  4. later (separate task?) update the keyword usage in the examples to Ruby 3.0 syntax
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant