Skip to content

Add naming conventions for instruments#4368

Merged
bors[bot] merged 4 commits intomicrosoft:masterfrom
jenshnielsen:docs/naming_drivers
Jul 7, 2022
Merged

Add naming conventions for instruments#4368
bors[bot] merged 4 commits intomicrosoft:masterfrom
jenshnielsen:docs/naming_drivers

Conversation

@jenshnielsen
Copy link
Copy Markdown
Collaborator

Triggered by #4365 let's define some standard naming conventions to avoid confusion in the future.

Copy link
Copy Markdown
Contributor

@astafan8 astafan8 left a comment

Choose a reason for hiding this comment

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

Awesome!

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 6, 2022

Codecov Report

Merging #4368 (dc09ed1) into master (bf7e5b7) will increase coverage by 0.99%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4368      +/-   ##
==========================================
+ Coverage   67.35%   68.35%   +0.99%     
==========================================
  Files         275      275              
  Lines       30965    31014      +49     
==========================================
+ Hits        20857    21199     +342     
+ Misses      10108     9815     -293     

jenshnielsen and others added 2 commits July 6, 2022 16:32
Co-authored-by: Mikhail Astafev <astafan8@gmail.com>
@jenshnielsen jenshnielsen added driver docs Related to docs improvements labels Jul 6, 2022
@jenshnielsen
Copy link
Copy Markdown
Collaborator Author

@trevormorgan since we are using bors we don't need to merge master back into the branch

@jenshnielsen
Copy link
Copy Markdown
Collaborator Author

bors merge

@bors bors bot merged commit 1f6c7cc into microsoft:master Jul 7, 2022
@jenshnielsen jenshnielsen deleted the docs/naming_drivers branch July 7, 2022 08:16
bors bot added a commit that referenced this pull request Aug 1, 2022
4371: Update agilent drivers to conform to docs standard r=jenshnielsen a=jenshnielsen

Updates to implement #4368  for Agilent. Closes #4365 

`@mgunyho` Could you test the new driver. I have updated the name of the variable and gotten rid of the not needed deg2rad converters and replaced them with numpy

I also suggest that we get rid of the autogenerated docs for the instruments and replace them with something like this.
I would like to add autodocsumm for these modules but am facing the same issue as in #4273

Co-authored-by: Jens H. Nielsen <Jens.Nielsen@microsoft.com>
@jenshnielsen jenshnielsen added this to the Public api rewrite milestone Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Related to docs improvements driver

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants