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/Update or kill obsolete documentation #918

Merged

Conversation

WilliamHPNielsen
Copy link
Contributor

@WilliamHPNielsen WilliamHPNielsen commented Dec 14, 2017

Fixes #839

Changes proposed in this pull request:

  • Update the old and broken documentation

Documentation completed:

  • Metadata.ipynb
  • Metadata with instruments.ipynb
  • Qcodes location-format example.ipynb
  • index.rst

@QCoDeS/core

@WilliamHPNielsen WilliamHPNielsen changed the title docs/Update or kill obsolete notebooks docs/Update or kill obsolete documentation Dec 14, 2017
@microsoft microsoft deleted a comment from codecov bot Dec 14, 2017
@codecov
Copy link

codecov bot commented Dec 14, 2017

Codecov Report

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

@@           Coverage Diff           @@
##           master     #918   +/-   ##
=======================================
  Coverage   78.63%   78.63%           
=======================================
  Files          33       33           
  Lines        4536     4536           
=======================================
  Hits         3567     3567           
  Misses        969      969

This notebook does not clarify much. It's overwhelming with too many
slobbily written example notebooks. Better to have a few comprehensive ones.
@WilliamHPNielsen
Copy link
Contributor Author

So I had some problems with the docs build. In markdown, you can have a line break by adding two whitespaces, so that this: Line␣one␣␣Line␣two turns into

Line one
Line two

which I used in a notebook, but that apparently leads to invalid .rst files. Shooks.

@WilliamHPNielsen
Copy link
Contributor Author

This one is ready for review now.

@jenshnielsen
Copy link
Collaborator

@WilliamHPNielsen The annoying thing is that travis runs Ubuntu 14.04 which has a quite old version of Pandoc with lots of bugs that are fixed in newer versions (as the one that you are likely to have from Homebrew or any other source of install on your own computer)

@WilliamHPNielsen
Copy link
Contributor Author

@jenshnielsen I see. I did indeed have some problems reproducing the results locally. That's also why I "reported" the problem here, just in case anyone else runs into it.

Copy link
Collaborator

@jenshnielsen jenshnielsen left a comment

Choose a reason for hiding this comment

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

Looks like a clear improvement

@jenshnielsen jenshnielsen merged commit 88804ab into microsoft:master Dec 18, 2017
giulioungaretti pushed a commit that referenced this pull request Dec 18, 2017
Author: William H.P. Nielsen <whpn@mailbox.org>

    docs/Update or kill obsolete documentation (#918)
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