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.

Sign up for GitHub

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

Jump to bottom

test/doc processors test should not rely on docs/docs.json #172

Closed
JasonShin opened this issue Dec 15, 2018 · 2 comments
Closed

test/doc processors test should not rely on docs/docs.json #172

JasonShin opened this issue Dec 15, 2018 · 2 comments
Labels
enhancement New feature or request

Comments

@JasonShin
Copy link
Member

JasonShin commented Dec 15, 2018 •
edited
Loading

  • I'm submitting a ...
    [/] tests enhancement

  • Summary
    The documentation processor unit tests are currently relying on the dynamically generated doc.json. However, this is a fragile approach, which will break the tests upon updating the doc strings. Refactor the doc processor test to use the docs.json snapshot instead and locate it in the same folder as the doc processor tests.

Process:

  1. Branch off develop and refactor
  2. Merge develop to v2
  3. Branch off v2 and refactor
@JasonShin JasonShin added the enhancement New feature or request label Dec 15, 2018
@JasonShin
Copy link
Member Author

This is currently work in progress in #173

@JasonShin
Copy link
Member Author

This is already merged into v2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JasonShin