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

End to end testing for RDoc#generate #1180

Open
st0012 opened this issue Sep 27, 2024 · 1 comment
Open

End to end testing for RDoc#generate #1180

st0012 opened this issue Sep 27, 2024 · 1 comment

Comments

@st0012
Copy link
Member

st0012 commented Sep 27, 2024

Currently no tests cover RDoc#generate which means we're not testing:

  • The file generation logic
  • The output message of doc generation

To test it right, we need to make sure we generate the documentation in a isolated place (e.g. a temp folder) and the files must be cleaned up after each test run.

@BurdetteLamar
Copy link
Member

"End-to-end" means (?):

  • Front end (input) is:
    • .rb files with embedded doc.
    • .c files with embedded doc.
    • .md files.
    • .rdoc files.
  • Back end (output) is:
    • HTML files (darkfish).
    • RI files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants