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

fix: Exclude spec files from typedoc generation #133

Merged
merged 1 commit into from
Nov 27, 2018

Conversation

pselden
Copy link
Contributor

@pselden pselden commented Oct 29, 2018

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    Bug fix.

  • What is the current behavior? (You can also link to an open issue here)
    Currently spec files are included in typedoc generation, leading to filling your docs with stuff from your tests.

  • What is the new behavior (if this is a feature change)?
    Remove spec files from doc generation so they do not show up in your docs.

  • Other information:
    See How does exclude work ? TypeStrong/typedoc#170 (comment) for exclude intructions

Previously would fill your documentation menu with garbage from your spec files.
@codecov
Copy link

codecov bot commented Oct 29, 2018

Codecov Report

Merging #133 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #133   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           9      9           
  Lines         256    256           
  Branches       38     38           
=====================================
  Hits          256    256

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 9bdf46a...d8f0f1e. Read the comment docs.

@bitjson bitjson merged commit bd7f021 into bitjson:master Nov 27, 2018
@bitjson
Copy link
Owner

bitjson commented Nov 27, 2018

@pselden thanks for the PR!

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

Successfully merging this pull request may close these issues.

2 participants