You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are a number of domain-specific terms and generic terms that have a very specific meaning such as Identifier, DateTime, and visit that should be documented somewhere.
For example, specifying that timetable.visits_between takes two DateTime arguments and returns a list of visits does not mean the arguments/return values are of those types, but rather than they meet the structural requirements of those types. In this case, a DateTime is a String in the format YYYYMMDD HH:mm:ss, and a visit is a tuple in the format (eta, etd, route, headsign).
Right now, users have to interpolate the meaning of these terms from topic descriptions and samples, which is not something that can always been relied upon. Giving these terms complete definitions would make this a non-issue, so long as users know where to look up these terms.
Adding a "Glossary" section would suit this need, and could be displayed inline with topics in the jump menu for easy access.
The text was updated successfully, but these errors were encountered:
There are a number of domain-specific terms and generic terms that have a very specific meaning such as
Identifier
,DateTime
, andvisit
that should be documented somewhere.For example, specifying that
timetable.visits_between
takes twoDateTime
arguments and returns a list ofvisits
does not mean the arguments/return values are of those types, but rather than they meet the structural requirements of those types. In this case, aDateTime
is aString
in the formatYYYYMMDD HH:mm:ss
, and a visit is a tuple in the format(eta, etd, route, headsign)
.Right now, users have to interpolate the meaning of these terms from topic descriptions and samples, which is not something that can always been relied upon. Giving these terms complete definitions would make this a non-issue, so long as users know where to look up these terms.
Adding a "Glossary" section would suit this need, and could be displayed inline with topics in the jump menu for easy access.
The text was updated successfully, but these errors were encountered: