NA and NaN docs #411
NA and NaN docs #411
Conversation
Jolanrensen
added
the
documentation
|
You want to add only interfaces with kdocs for now, right? And reference it from related operations later. Just making sure. Otherwise looks good. |
The NA and NaN interfaces are already referenced to from fillNA, dropNA etc. in the code :) People can click on the reference to read more about the concepts. I just updated them with a URL. |
| @@ -19,6 +19,17 @@ internal interface DocumentationUrls { | |||
| interface RowConditions | |||
| } | |||
|
|
|||
| /** [See `NaN` and `NA` on the documentation website.](https://kotlin.github.io/dataframe/nanAndNa.html) */ | |||
There was a problem hiding this comment.
Looks like a new pattern to refer on the Documentation site. Is it correct that we did not do it earlier?
It seems good idea, but probably let's discuss it widely.
Because it looks like adding yet one detail to the hierarchy of documents produced by your plugin
There was a problem hiding this comment.
No, it was used before in Update.kt and Nulls.kt, you can see the other URLs in the file ;)
...d-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
Outdated
Show resolved
Hide resolved
| @@ -35,6 +35,7 @@ | |||
| <toc-element topic="DataColumn.md"/> | |||
| <toc-element topic="DataRow.md"/> | |||
| </toc-element> | |||
| <toc-element topic="nanAndNa.md"/> | |||
There was a problem hiding this comment.
probably better to move under operations (for first time)
There was a problem hiding this comment.
But it's not an operation. I'm not comfortable having it there, seems weird. Probably we can find a better place after restructuring the docs/flattening them.
#109
I added docs and references to it from other files + kdocs.
I don't know where to put this file in the tree, however.... It's not an operation, it's closest to a data abstraction maybe, but not entirely. I made it a separate tab for now.