Skip to content

Commit

Permalink
Address @shwina's comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
vyasr committed Jul 18, 2022
1 parent 9c03234 commit 5dc2982
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions docs/cudf/source/developer_guide/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,6 @@ These pages are all written using MyST, a superset of Markdown.
MyST allows developers to write using familiar Markdown syntax,
while also providing the full power of reST where needed.
These pages do not conform to any specific style or set of use cases.
**Does it make sense to request this?**:
However, if you develop any sufficiently complex new features,
consider whether users would benefit from a more complete demonstration of them.

Expand Down Expand Up @@ -195,5 +194,3 @@ Documenting internals is strongly encouraged, but not enforced in any particular
Regarding style, either full numpy-style docstrings or regular `#` comments are acceptable.
The former can be useful for complex or widely used functionality,
while the latter is fine for small one-off functions.
In general, the degree of documentation required for internals is determined by PR review.
Use your best judgment when writing such functions, then expect to iterate as needed during review.

0 comments on commit 5dc2982

Please sign in to comment.