Improve the YARD API documentation

igneus / calendarium-romanum

liturgical calendar library (Roman Catholic, post-Vatican II)

50 stars 21 forks source link

Improve the YARD API documentation #23

Closed igneus closed 4 years ago

igneus commented 6 years ago

There are a lot of undocumented or underdocumented methods, here and there descriptions may be outdated.

(Small PRs dealing with documentation of a single class or file are preferable.)

aredshaw commented 5 years ago

Are you using REST APIs? If so, I might be able to help. What are the following?

The base path
Endpoints
All possible methods and parameters
An API Key (If required)

igneus commented 5 years ago

No, this is a Ruby library, not an application. By "API" the library's public interface (classes and methods intended to be used by code using the library) is meant. YARD is a Ruby tool generating documentation from class/method comments. The current state of the documentation can be seen here.

igneus commented 4 years ago

Closing - the API documentation is mostly sufficient now.