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

missing content in documentation: motorDeviceDriver.html #54

Open
prjemian opened this issue Feb 7, 2017 · 6 comments
Open

missing content in documentation: motorDeviceDriver.html #54

prjemian opened this issue Feb 7, 2017 · 6 comments
Labels
Milestone

Comments

@prjemian
Copy link
Contributor

prjemian commented Feb 7, 2017

This file ends with The asynMotorAxis base class defines the following methods: but no further text is provided.

View as HTML: http://htmlpreview.github.io/?https://raw.githubusercontent.com/epics-modules/motor/master/documentation/motorDeviceDriver.html

View as raw: https://raw.githubusercontent.com/epics-modules/motor/master/documentation/motorDeviceDriver.html

View as content: https://github.com/epics-modules/motor/blob/master/documentation/motorDeviceDriver.html

@prjemian prjemian added the bug label Feb 7, 2017
@prjemian prjemian added this to the R6-10 milestone Feb 7, 2017
@prjemian
Copy link
Contributor Author

prjemian commented Feb 7, 2017

@MarkRivers: The commit d01040c left this section with missing content. Should content be added or should the section be removed?

@MarkRivers
Copy link
Member

That document needs to be completed. This is that last commit message:

Author: MarkRivers rivers@cars.uchicago.edu
Date: Mon May 25 19:45:52 2015 +0000

Removed old stuff about mar345 left over from document creation; document is still very incomplete

It would be very useful for this document to describe the Model 3 API, including the multi-axis coordinated move methods.

I'll try to make some time to work on it.

@kmpeters kmpeters modified the milestones: R6-10, R6-10-1 Nov 30, 2017
@kmpeters kmpeters modified the milestones: R6-10-1, R6-11 May 2, 2018
@kmpeters
Copy link
Member

I recently renamed the documentation directory so we could use the github.io url. Updated links are below.

View as HTML: https://epics-modules.github.io/motor/motorDeviceDriver.html

View as raw: https://raw.githubusercontent.com/epics-modules/motor/master/docs/motorDeviceDriver.html

View as content: https://github.com/epics-modules/motor/blob/master/docs/motorDeviceDriver.html

@kmpeters
Copy link
Member

@MarkRivers, there will be a 6-11 release of the motor module in the near future. Would you like the missing documentation to be included in it? I realize that the missing documentation is very likely the least important thing on your to-do list.

@MarkRivers
Copy link
Member

I don't think I will have a chance to complete that document before the release. I added a note at the end of the file saying it still needs to be completed to reduce confusion.

@prjemian
Copy link
Contributor Author

prjemian commented Mar 6, 2019

R6-11 has been released. We should move this issue to another milestone and close the R6-11 milestone.

@prjemian prjemian modified the milestones: R6-11, R7-0 Mar 6, 2019
@kmpeters kmpeters modified the milestones: R7-0, R7-1 Apr 19, 2019
@kmpeters kmpeters modified the milestones: R7-1, Future Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants