Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code documentation: Updating existing code documents #3095

Closed
TomFinley opened this issue Mar 26, 2019 · 1 comment
Closed

Code documentation: Updating existing code documents #3095

TomFinley opened this issue Mar 26, 2019 · 1 comment
Assignees
Labels
code-sanitation Code consistency, maintainability, and best practices, moreso than any public API. documentation Related to documentation of ML.NET

Comments

@TomFinley
Copy link
Contributor

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.

@TomFinley TomFinley added documentation Related to documentation of ML.NET code-sanitation Code consistency, maintainability, and best practices, moreso than any public API. labels Mar 26, 2019
@TomFinley TomFinley self-assigned this Mar 26, 2019
@shmoradims
Copy link

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.

@ghost ghost locked as resolved and limited conversation to collaborators Mar 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
code-sanitation Code consistency, maintainability, and best practices, moreso than any public API. documentation Related to documentation of ML.NET
Projects
None yet
Development

No branches or pull requests

2 participants