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

Docs fixes #1663

Merged
merged 3 commits into from Jul 25, 2019
Merged

Docs fixes #1663

merged 3 commits into from Jul 25, 2019

Conversation

@dbczumar
Copy link
Collaborator

dbczumar commented Jul 24, 2019

What changes are proposed in this pull request?

A few small docs fixes for the following issues:

  1. Docs for MlflowClient.log_metric are improperly indented; this causes Sphinx rendering issues
  2. Docs for MlflowClient.delete_tag and mlflow.delete_tag do not contain a space between the method description and the parameter list; this also causes Sphinx rendering issues
  3. mlflow.delete_tag is not included in the MLflow fluent API docs due to its absence from mlflow.__all__ :/

How is this patch tested?

Manual docs generation

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

Yes, but these are small docs tweaks that do not merit a release notes entry.

What component(s) does this PR affect?

  • UI
  • CLI
  • API
  • REST-API
  • Examples
  • Docs
  • Tracking
  • Projects
  • Artifacts
  • Models
  • Scoring
  • Serving
  • R
  • Java
  • Python

How should the PR be classified in the release notes? Choose one:

  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes
@dbczumar dbczumar requested review from smurching and ankitmathur-db Jul 24, 2019
@dbczumar dbczumar added the rn/none label Jul 24, 2019
Copy link
Contributor

smurching left a comment

LGTM

@smurching smurching merged commit 1c85add into mlflow:master Jul 25, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.