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.

Sign up for GitHub

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

Jump to bottom

Documentation for api reloadConfig incomplete #797

Closed
mikeyg123 opened this issue Jul 21, 2016 · 1 comment
Closed

Documentation for api reloadConfig incomplete #797

mikeyg123 opened this issue Jul 21, 2016 · 1 comment
Labels
docs

Comments

@mikeyg123
Copy link

The documentation for the reloadConfig() api method on the web site doesn't describe the list of added/changed/removed groups in the returned structure.
Also details for addProcessGroup() and removeProcessGroup() don't really describe what they do. Some information about the concept of pending changes which get accepted by calling {add, remove}ProcessGroup() would really help people. Only after looking at the source code were we able to understand what they do and how useful they are and build a UI which lets users individually examine pending changes and apply them.
@mnaberez mnaberez added the docs label Jul 21, 2016
@timmartin timmartin mentioned this issue Dec 11, 2016
Merged
@mnaberez
Copy link
Member

reloadConfig docs added in 219f7af.

mnaberez pushed a commit that referenced this issue May 27, 2017
@timmartin @mnaberez
Improved the documentation of the reloadConfig API method
e000c35 
This addresses issue #797
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mnaberez @mikeyg123