docs: initialize the documentation#24
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
src/pdfbl/sequential/pdfadapter.py
Outdated
| The minimum Q value for PDF calculation. Default is None. | ||
| qmax : float, optional | ||
| qmax : float | ||
| The maximum Q value for PDF calculation. Default is None. |
There was a problem hiding this comment.
maybe check these. The default argument may be None but is it not then handled later? So the default rstep ends up as 0.01 or something like that? In those cases, in the docstring you want to put what is useful to the user, not what is useful to hte developer (who can look at the code in any case)
src/pdfbl/sequential/pdfadapter.py
Outdated
| ---------- | ||
| equation_string : str, optional | ||
| equation_string : str | ||
| The equation string defining the contribution. If None, a default |
There was a problem hiding this comment.
again here, the user won't know what "If None" means so it is better to just say what is created by default. what is written now is a bit vague so I am not able to tell you exactly what to write.
ycexiao
left a comment
ycexiao
left a comment
There was a problem hiding this comment.
@sbillinge, it's ready for review.
| equation_string : str | ||
| The equation string defining the contribution. If None, a default | ||
| equation will be generated based on the number of phases. | ||
| e.g. |
src/pdfbl/sequential/pdfadapter.py
Outdated
| dx : float, optional | ||
| The r step size for PDF calculation. Default is None. | ||
| qmin : float | ||
| The minimum Q value for PDF calculation. If None, use the value |
There was a problem hiding this comment.
Add the description for the default behavior.
There was a problem hiding this comment.
These are good but please don't say "if None...." As users won't know what it means. Say "Default value..." Or "defaults to..."
There was a problem hiding this comment.
These are good but please don't say "if None...." As users won't know what it means. Say "Default value..." Or "defaults to..."
|
@sbillinge, it's ready for review. |
2 participants
What problem does this PR address?
What should the reviewer(s) do?
Please see the rendered documentation:
