Skip to content
This repository was archived by the owner on Jan 15, 2024. It is now read-only.

Conversation

liusy182
Copy link
Contributor

Description

This PR fixes a few documentation inconsistencies in package gluonnlp.vovab

Checklist

Essentials

  • PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage
  • Code is well-documented

Changes

  • use the same parameter name in method signature and method documentation.

  • explicitly document RuntimeException

Comments

@liusy182 liusy182 requested a review from szha as a code owner August 18, 2019 05:00
@codecov
Copy link

codecov bot commented Aug 18, 2019

Codecov Report

❗ No coverage uploaded for pull request head (vocab-doc@6d08590). Click here to learn what that means.
The diff coverage is n/a.

@codecov
Copy link

codecov bot commented Aug 18, 2019

Codecov Report

Merging #885 into master will decrease coverage by 0.04%.
The diff coverage is 75%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #885      +/-   ##
==========================================
- Coverage   90.43%   90.38%   -0.05%     
==========================================
  Files          66       66              
  Lines        6367     6367              
==========================================
- Hits         5758     5755       -3     
- Misses        609      612       +3
Impacted Files Coverage Δ
src/gluonnlp/vocab/subwords.py 81.13% <75%> (ø) ⬆️
src/gluonnlp/data/utils.py 70.74% <0%> (-2.05%) ⬇️

@mli
Copy link
Member

mli commented Aug 18, 2019

Job PR-885/1 is complete.
Docs are uploaded to http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-885/1/index.html

@szha szha requested review from leezu and eric-haibin-lin August 18, 2019 19:10
Copy link
Contributor

@leezu leezu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@eric-haibin-lin eric-haibin-lin merged commit 2842799 into dmlc:master Aug 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants