ISISNeutronMuon / ISISNeutronMuon/p4pillon

improve documentation

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

To make the library complete and usable for other facilities, we should add/expand the following documentation:
- [ ] README
- [ ] GitHub pages (including workflow)
- [ ] docstrings
- [ ] examples

This documentation should be associated with a code review by a relatively unfamiliar user to validate it's usefulness.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.