Skip to content

Mixed documentation for simrel function #5

@khliland

Description

@khliland

In the "umbrella" function simrel(), the input and output descriptions are a bit misleading.

  1. The q argument is only described in form of its content, not its role/function,
  2. and the comment "for details see Notes" seems to be a remnant from unisimrel() as simrel() has no Notes section.
  3. The list of return variables might be correct for one of the simrel-methods that this function branches out to, but for instance, unisimrel() only contains a subset of the return values.

Additional suggestion: "See also" pointing to the specializations would be useful and maybe an example or pointer to the other examples.

Otherwise, excellent package!

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions