Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mixed documentation for simrel function #5

Open
khliland opened this issue Sep 29, 2022 · 1 comment
Open

Mixed documentation for simrel function #5

khliland opened this issue Sep 29, 2022 · 1 comment
Assignees
Labels

Comments

@khliland
Copy link

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!

@therimalaya
Copy link
Collaborator

Thank you for pointing out the problems. I will fix them as soon as possible (probably within this month). I have prepared a new version of simrel, which is a bit more functional by separating model properties and data, but it will not be compatible with this current version in terms of output. Let's see if I can keep it in a different repository or another branch of this repo. But the suggestion you have pointed out will be helpful in both situations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants