You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can run the Scaladoc tool from the sbt prompt as a user would run it
66
+
with `scaladoc/run`, passing `-d <directory>` and some `.tasty` files as
67
+
input on the command line.
68
+
65
69
### Testing
66
70
71
+
From the sbt prompt, `scaladoc/test` runs the tests.
72
+
73
+
You can also run specific signature tests with `testOnly`,
74
+
for example `scaladoc/test *scaladoc.signatures.MarkdownCode`.
75
+
67
76
Most tests rely on comparing signatures (of classes, methods, objects etc.) extracted from the generated documentation
68
-
to signatures found in source files. Such tests are defined using [SignatureTest](test/dotty/tools/scaladoc/signatures/SignatureTest.scala) class
69
-
and its subtypes (such as [TranslatableSignaturesTestCases](test/dotty/tools/scaladoc/signatures/TranslatableSignaturesTestCases.scala))
77
+
to signatures found in source files (extracted using Scalameta). Such tests are defined using [SignatureTest](test/dotty/tools/scaladoc/signatures/SignatureTest.scala) class
78
+
and its subtypes (such as [TranslatableSignaturesTestCases](test/dotty/tools/scaladoc/signatures/TranslatableSignaturesTestCases.scala)). In this style of test, it's not necessary for expected output to be included, because the test is its own specification.
70
79
71
80
WARNING: As the classes mentioned above are likely to evolve, the description below might easily get out of date.
72
81
In case of any discrepancies rely on the source files instead.
@@ -121,25 +130,8 @@ class Bar
121
130
122
131
Otherwise the implementation would be treated as a part of the signature.
123
132
124
-
## Contributing
125
-
126
-
We're happy that you'd like to help us!
127
-
128
-
We have two issue labels you should take a look at: `good first issue` and
129
-
`self-contained`. First is easy pickings: you'll be able to contribute without
130
-
needing to dive too deep into the project. Second is reverse: it's an issue
131
-
that's you may find interesting, complex and self-contained enough that you can
132
-
continue chipping away at it without needing to worry too much about merge
133
-
conflicts.
134
-
135
-
To contribute to the project with your code, fork this repo and create a pull request from a fresh branch from there.
136
-
To keep the history of commits clean, make sure your commits are squashed into one
137
-
and all your changes are applied on top of the latest master branch (if not - rebase on it instead of merging it).
138
-
Make sure all the tests pass (simply run `sbt test` to verify that).
139
-
140
133
## FAQ
141
134
142
-
143
135
### Why use TASTy?
144
136
145
137
A documentation tool needs to access compiler information about the project - it
0 commit comments