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

Add documentation for the new model docstring standard #906

Merged
merged 7 commits into from
Mar 8, 2022

Conversation

ablaom
Copy link
Member

@ablaom ablaom commented Mar 1, 2022

Context: #901.

Friendlier view of the addition in this PR: https://github.com/alan-turing-institute/MLJ.jl/blob/standardize-docstrings/docs/src/adding_models_for_general_use.md#document-strings

Still to do:

  • A second exemplar for transformers

@ablaom ablaom marked this pull request as draft March 1, 2022 03:51
@codecov-commenter
Copy link

Codecov Report

Merging #906 (a9e02be) into dev (cc3ec00) will not change coverage.
The diff coverage is n/a.

❗ Current head a9e02be differs from pull request most recent head d1e2870. Consider uploading reports for the commit d1e2870 to get more accurate results

Impacted file tree graph

@@           Coverage Diff           @@
##              dev     #906   +/-   ##
=======================================
  Coverage   42.85%   42.85%           
=======================================
  Files           1        1           
  Lines          28       28           
=======================================
  Hits           12       12           
  Misses         16       16           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc3ec00...d1e2870. Read the comment docs.

@ablaom ablaom marked this pull request as ready for review March 8, 2022 04:41
@ablaom ablaom merged commit 9418e71 into dev Mar 8, 2022
@ablaom ablaom mentioned this pull request Mar 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants