Code documentation: Updating existing code documents #3095
Labels
code-sanitation
Code consistency, maintainability, and best practices, moreso than any public API.
documentation
Related to documentation of ML.NET
Many of the documents describing the code and the principles that make it work need to be updated. Sometimes this updating will take the form of just updating the type names (e.g., what we used to call
ColumnType
is notDataViewType
,ICursor
interface has been subsumed by theRowCursor
abstract class), and sometimes will take the form of changing the content rather entirely (e.g., we used to consider throwing in cursors bad practice, now we need to explain why we changed our mind, also, we've restricted key-types so that they are explicitly enumerations over sets rather than trying to do a bunch of additional things we never once found useful).Note that this is distinct from #2054, which is more about user-facing documentation and samples. This is more about the documentation of the principles upon which our code relies.
The text was updated successfully, but these errors were encountered: