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

Documentation style #205

Open
nward opened this issue Aug 18, 2023 · 0 comments
Open

Documentation style #205

nward opened this issue Aug 18, 2023 · 0 comments

Comments

@nward
Copy link
Collaborator

nward commented Aug 18, 2023

As mentioned in a comment on #199, I think we should have a conscious decision on what we are documenting in params etc. documentations.

Should we be documenting:
a) The behaviour that FreeRADIUS will have if the user sets a parameter, as we currently do, or;
b) The behaviour that this module will have - i.e. that x parameter in y freeradius module will be set to value z

My proposal is that documentation should target (b), as FreeRADIUS' behaviour can change, and I don't think we can capture that in a reasonable way while supporting multiple versions.

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

No branches or pull requests

1 participant