search

pittcsc / PittAPI

An API to easily get data from the University of Pittsburgh
https://pittapi.pittcsc.org
GNU General Public License v2.0
105 stars 30 forks source link

Course API function name change #86

Closed azharichenko closed 6 years ago

azharichenko commented 6 years ago

During a coding interview, the interviewer pointed out the confusion that get_courses has. Because, based on the name, it should probably return all the courses available within a subject. But instead, we give all the classes that are available for the term.

So I simply changed the function from get_courses to get_classes. With this, I maintained that get_courses will still work but now will throw a warning to the developer to switch over. I think in a future version of this API we should return the results of peoplesoft mobile's course catalog since it would better reflect what get_course should return.

RitwikGupta commented 6 years ago

This is very fair. External code reviews ftw. Thanks for marking it as deprecated and not just removing it!