Skip to content

Code documentation: Updating existing code documents #3095

Closed

Description

@TomFinley

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 not DataViewType, ICursor interface has been subsumed by the RowCursor 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.

Activity

  1. self-assigned this
    on Mar 26, 2019
  2. shmoradims commented on May 21, 2019

    @shmoradims

    Seems like most of the issues are addressed by Tom's 4 PRs above. @TomFinley if there's any topic that's not covered by your recent PRs above, please let us know and I'll create a separate issue for it. Closing for now.

  3. ghost locked as resolved and limited conversation to collaborators on Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationRelated to documentation of ML.NET

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions