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

Properly document ResourceLevels #74

Closed
maxfischer2781 opened this issue Nov 17, 2019 · 0 comments · Fixed by #78
Closed

Properly document ResourceLevels #74

maxfischer2781 opened this issue Nov 17, 2019 · 0 comments · Fixed by #78
Labels
documentation enhancement New feature or request

Comments

@maxfischer2781
Copy link
Contributor

Short description of the feature
The documentation for ResourceLevels is lacking, and the eval source is extremely hard to understand. Provide full description and examples.

Describe the solution you'd like
Document automatic features. Provide examples for frequently encountered misuses.

# antipattern
dict(self._usedstorage.levels)["usedsize"]
# direct access
self._usedstorage.levels.usedsize
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document ResourceLevels MaineKuehn/usim
1 participant
@maxfischer2781