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

Improve documentation #7813

Merged
merged 4 commits into from
Jul 3, 2019
Merged

Improve documentation #7813

merged 4 commits into from
Jul 3, 2019

Conversation

villebro
Copy link
Member

@villebro villebro commented Jul 3, 2019

CATEGORY

Choose one

  • Bug Fix
  • Enhancement (new features, refinement)
  • Build / Development Environment
  • Documentation

SUMMARY

I was working on something unrelated and noticed the need to change the following:

  • Some documentation was emitting errors (incorrect headers etc)
  • No documentation for current_user_id and current_username jinja functions
  • Bump Sphinx deps and add support for type annotations (added dependency on MIT licensed sphinx_autodoc_typehints)

TEST PLAN

Tested locally

BEFORE

image

AFTER

image

REVIEWERS

@mistercrunch @john-bodley

@codecov-io
Copy link

codecov-io commented Jul 3, 2019

Codecov Report

Merging #7813 into master will decrease coverage by <.01%.
The diff coverage is 64.28%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #7813      +/-   ##
==========================================
- Coverage   65.89%   65.89%   -0.01%     
==========================================
  Files         459      459              
  Lines       22011    22016       +5     
  Branches     2417     2417              
==========================================
+ Hits        14505    14507       +2     
- Misses       7385     7388       +3     
  Partials      121      121
Impacted Files Coverage Δ
superset/jinja_context.py 75.26% <64.28%> (-2.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 6d7701e...68c69a3. Read the comment docs.

@@ -47,6 +47,7 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx_autodoc_typehints',
Copy link
Member

Choose a reason for hiding this comment

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

This is sweet.

@villebro
Copy link
Member Author

villebro commented Jul 3, 2019

I'll go ahead and merge this right away, I have another PR that is partially dependent on this.

@villebro villebro merged commit 0125ba4 into apache:master Jul 3, 2019
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.34.0 labels Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 0.34.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants