Add initial docs #37
Merged
Add initial docs #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #37 +/- ##
==========================================
- Coverage 95.31% 94.59% -0.72%
==========================================
Files 9 9
Lines 128 111 -17
==========================================
- Hits 122 105 -17
Misses 6 6
Continue to review full report at Codecov.
|
glennmoy
reviewed
Mar 2, 2021
- Separate out different topics in sections, with more examples - Make `cols` example clearer - Add section on transform-specific keyword arguments - Put each sentence on a new line
morris25
reviewed
Mar 4, 2021
docs/src/transforms.md
Outdated
| Without specifying optional arguments, a `Transform` is applied to every element of an `AbstractArray` and in an element-wise fashion: | ||
|
|
||
| ```jldoctest transforms | ||
| julia> M = [2 4; 1 5; 3 6]; |
There was a problem hiding this comment.
You might want to change this to a float array to avoid failing the 32 bit tests
glennmoy
reviewed
Mar 5, 2021
docs/src/transforms.md
Outdated
Comment on lines
80
to
82
| Some `Transform` subtypes have restrictions on how they can be applied once constructed. | ||
| For instance, `MeanStdScaling` stores the mean and standard deviation of some data for specified dimensions or column names. | ||
| So `MeanStdScaling` should only be applied to the same data type and for the same dimensions or subset of column names specified in construction. |
There was a problem hiding this comment.
I'll address this (and any other things that conflict) when I finish #42
glennmoy
reviewed
Mar 5, 2021
glennmoy
approved these changes
Mar 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #36
Includes pages for an introduction, the API, overview of how
Transforms work, and a longer example.Note the built docs can be previewed by clicking the "details" link next to the documenter/deploy check.