cubehouse / themeparks

Unofficial API for accessing ride wait times and schedules for Disneyland, Disney World, Universal Studios, and many more parks
MIT License
540 stars 126 forks source link

Documentation errors #194

Closed webdeck closed 5 years ago

webdeck commented 5 years ago

Park Disney parks

Context

Describe the bug Documentation states the ride wait times results contains:

        fastPassReturnTime: { (object containing current return times, parks supporting this will set FastPassReturnTimes to true - entire field may be null for unsupported rides or when fastPass has ran out for the day)
            startTime: (string return time formatted as "HH:mm": start of the current return time period),
            endTime: (string return time formatted as "HH:mm": end of the current return time period),
            lastUpdate: (JavaScript Date object: last time the fastPass return time changed),
        },

However, it is actually:

        meta: { (object containing current return times, parks supporting this will set FastPassReturnTimes to true - entire field may be null for unsupported rides or when fastPass has ran out for the day)
            fastPassStartTime: (string return time formatted as "HH:mm": start of the current return time period),
            fastPassEndTime: (string return time formatted as "HH:mm": end of the current return time period),
        },

Output n/a

cubehouse commented 5 years ago

Documentation here seems to be correct? https://github.com/cubehouse/themeparks#ride-wait-times

Please raise a pull request if it is wrong elsewhere so I can be clear where this issue occurs.

webdeck commented 5 years ago

Ah, sorry. It's incorrect in docs/index.html

webdeck commented 5 years ago

Also, it's missing the possible value 'Refurbishment' for status in both README.md and docs/index.html