Skip to content
This repository has been archived by the owner on Nov 21, 2023. It is now read-only.

Fix some errors in API docs and link to DTMO #239

Merged
merged 1 commit into from
Nov 2, 2018
Merged

Conversation

jklukas
Copy link
Contributor

@jklukas jklukas commented Nov 2, 2018

No description provided.

@jklukas jklukas requested a review from wlach November 2, 2018 13:42
@codecov-io
Copy link

codecov-io commented Nov 2, 2018

Codecov Report

Merging #239 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #239   +/-   ##
=======================================
  Coverage   80.05%   80.05%           
=======================================
  Files          11       11           
  Lines        1053     1053           
=======================================
  Hits          843      843           
  Misses        210      210
Flag Coverage Δ
#py27 79.86% <ø> (ø) ⬆️
#py35 79.01% <ø> (ø) ⬆️
#py36 79.01% <ø> (ø) ⬆️

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 3b50362...724d311. Read the comment docs.

@jklukas jklukas force-pushed the ghpages-docs branch 2 times, most recently from d22bb8a to 5e21878 Compare November 2, 2018 13:51
README.md Outdated
Spark bindings for Mozilla Telemetry
PySpark bindings for Mozilla Telemetry

## Usage
Copy link
Contributor

Choose a reason for hiding this comment

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

I think less is more for this section. Let's just do something like:

## Documentation

Online documentation is available at https://mozilla.github.io/python_moztelemetry/

That way if the dtmo link ever changes, we only need to update it in one place.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will do

docs/conf.py Outdated
@@ -55,17 +55,17 @@

# General information about the project.
project = u'python_moztelemetry'
copyright = u'2016, Mozilla Firefox Data Platform'
copyright = u'2016-2018, Mozilla Firefox Data Platform'
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we just leave out the year? That piece of information always seems to go out of date

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will do

Copy link
Contributor

@wlach wlach left a comment

Choose a reason for hiding this comment

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

r+ with comments addressed

@jklukas jklukas merged commit 679b89b into master Nov 2, 2018
@jklukas jklukas deleted the ghpages-docs branch November 2, 2018 15:15
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.

3 participants