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

Typedoc Integration Tests #12

Open
devpaul opened this issue Apr 27, 2017 · 1 comment · May be fixed by #46
Open

Typedoc Integration Tests #12

devpaul opened this issue Apr 27, 2017 · 1 comment · May be fixed by #46
Labels
enhancement Infrastructure
Milestone
long-grass

Comments

@devpaul
Copy link
Member

devpaul commented Apr 27, 2017

Typedoc is an item undergoing major improvement while also being integral to all of the Dojo 2 projects. It would be good to have a set of integration tests to ensure given a set of inputs that we can produce a set of desired API documentation. There is currently a basic typedoc integration test that validates building API documentation outside of the current working directory. We should add tests that:

  • test typedoc's externalPattern and excludeExternals option
  • test typedoc's exclude option
  • test the creation of JSON with typedoc
  • test typedoc's includeDeclarations option
@dylans dylans added this to the 2017.05 milestone Apr 29, 2017
@jacobroufa
Copy link
Contributor

@eheasley I cannot edit the Estimate field for this issue, and I've not discussed this issue with @devpaul yet as I'm working on #11 first. Given that, I'm inclined to pad my estimate more, so probably 4-5 days of work. The tests are described above plainly enough but I've never worked with typedoc before, so I'll adjust this once I've got a better handle on what the expectations are for these tests.

@devpaul devpaul added the beta3 label May 10, 2017
@jacobroufa jacobroufa linked a pull request May 26, 2017 that will close this issue
Open
@morrinene morrinene assigned devpaul and unassigned jacobroufa Jun 6, 2017
@eheasley eheasley modified the milestones: 2017.05, 2017.06 Jun 6, 2017
@dylans dylans modified the milestones: 2017.06, 2017.07 Jul 4, 2017
@dylans dylans modified the milestones: 2017.07, 2017.08 Jul 29, 2017
@kitsonk kitsonk modified the milestones: 2017.08, 2017.09 Sep 4, 2017
@kitsonk kitsonk removed the beta3 label Oct 10, 2017
@kitsonk kitsonk modified the milestones: 2017.09, long-grass Oct 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Infrastructure
Projects
None yet
Milestone
long-grass
Development

Successfully merging a pull request may close this issue.

add Typedoc integration tests jacobroufa/grunt-dojo2-extras
6 participants
@dylans @devpaul @jacobroufa @kitsonk @morrinene @eheasley