API review

Proposer: Melonee Wise

Present at review:

• Stu
• John
• Vijay
• Tully

Question / concerns / comments

Enter your thoughts on the API and any questions / concerns you have here. Please sign your name. Anything you want to address in the API review should be marked down here before the start of the meeting.

Stu

• Rename generate_filter_coeffs program to filter_coeff_server to indicate that the program does not actually do anything directly, but rather provides the service.
• (Maybe) rename generate_filter_coeffs_client to either filter_coeff_client or just generate_filter_coeffs
• Why does all the documentation have [b,a] but the service definition has "a" then "b"?
• As a non-controls person, I could use a higher level description of what this package does. What are a and b? It can be brief, just f(x) = a*whatever + b*whatever (or whatever it's supposed to look like).
• Consider writing the client program in python. It's a good fit for just doing a quick service call
• Is there a better way to output a and b from the client program? An output format that you can directly paste into octave might be more useful.

Meeting agenda

To be filled out by proposer based on comments gathered during API review period

Conclusion

Package status change (also mark change on PackageStatusDict page)

• Rename generate_filter_coeffs program to filter_coeff_server to indicate that the program does not actually do anything directly, but rather provides the service.

• (Maybe) rename generate_filter_coeffs_client to either filter_coeff_client or just generate_filter_coeffs

• Why does all the documentation have [b,a] but the service definition has "a" then "b"?

• As a non-controls person, I could use a higher level description of what this package does. What are a and b? It can be brief, just f(x) = a*whatever + b*whatever (or whatever it's supposed to look like).

• Consider writing the client program in python. It's a good fit for just doing a quick service call

• Action items that need to be taken.

• Major issues that need to be resolved