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

Documentation changes #65

Merged
merged 7 commits into from
Jul 10, 2018
Merged

Conversation

T-Nicholls
Copy link
Contributor

@T-Nicholls T-Nicholls commented Jul 10, 2018

Amended index.rst for improved clarity, especially for beginners.
Changes:

  • reworded design paragraph to make the hierarchy clearer.
  • moved element families sentence to below design paragraph where it fits better.
  • added an explanation of handles after the element families sentence to make misc features paragraph.

To do:

  • add a sentence explaining the pv's names/values/IOC's/EPICS at the end of the first paragraph.
  • add an explanation about machines before the current machines sentence.
  • append an explanation of modes for load_csv() to the end of machines paragraph.
  • clarify the section on data and data conversion, there isn't anything similar the explanation you gave me about the current in the magnet vs the strength of the magnetic field being the distinction between ENG and PHYS, instead only a section on data conversion; in short lots about data conversion but nothing about data, an example would not go amiss.

@coveralls
Copy link

coveralls commented Jul 10, 2018

Coverage Status

Coverage remained the same at 94.321% when pulling 802a2ee on T-Nicholls:docChanges into 362ccce on willrogers:master.

@T-Nicholls
Copy link
Contributor Author

Changed examples.rst to make it more intuitive.
Changes:

  • Split initialisation section in into Installation and Initialisation and moved existing content accordingly.
  • Added new content to both Initialisation and Installation sections.
  • Updated the titles of BPM and QUAD example sections to better reflect their content.
  • Changed the wording of a few bullet points to improve clarity.

To do:

  • Add an explanation about 'VMX' ring mode.

@T-Nicholls T-Nicholls changed the title index.rst changes Documentation changes Jul 10, 2018
@willrogers
Copy link
Collaborator

These changes look good, except for a new semicolon. Are these really independent clauses?

https://writing.wisc.edu/Handbook/Semicolons.html

@T-Nicholls
Copy link
Contributor Author

Yep; it was incorrect, I have fixed it now.

@T-Nicholls
Copy link
Contributor Author

Changed pytac.rst; added pytac.utils automodule.

@willrogers willrogers merged commit c7efcd6 into DiamondLightSource:master Jul 10, 2018
@willrogers
Copy link
Collaborator

I merged this to generate a new version on readthedocs.

You can continue pushing to the same branch and create a new pull request with further changes.

@T-Nicholls T-Nicholls deleted the docChanges branch July 11, 2018 09:21
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

3 participants