The theory guide has a robust description of tallies and tally statistics, but the choice of phrasing in the API documentation is not entirely consistent with the phrasing used in the theory manual. This can lead to some confusion over which statistical response is provided by which API call and/or data member.
Related, there is a lack of user guide level documentation on reading and processing tallies. The documentation essentially links to a sample notebook but is not as rich as the documentation that describes how to setup/establish tallies.
This could be resolved by:
- a careful review of the language used in the API documentation vis-a-vis the theory manual for consistency
- links from the theory manual to specific API calls where appropriate
- addition of a richer description of how to access tally information, at least for the main and most common API calls
The theory guide has a robust description of tallies and tally statistics, but the choice of phrasing in the API documentation is not entirely consistent with the phrasing used in the theory manual. This can lead to some confusion over which statistical response is provided by which API call and/or data member.
Related, there is a lack of user guide level documentation on reading and processing tallies. The documentation essentially links to a sample notebook but is not as rich as the documentation that describes how to setup/establish tallies.
This could be resolved by: