Skip to content

Update README #10

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

Merged
maread99 merged 1 commit into from
Dec 2, 2025
Merged

Update README #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 1 addition & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,23 +111,10 @@ Function and method documentation:
* does not by default list all optional and keyword arguments, for which signatures should be inspected.
* does not state argument types or return values, for which signatures' annotation should be inspected.


Names referenced in documentation are surrounded by symbols that identify the nature of the assigned object:

Name | Nature of assigned object
---- | -------------------------
+parameter_name+ | Parameter of documented function or method.
++parameter_name++ | Parameter of class constructor method.
-variable_name- | Variable local to code being documented.
--attribute_name-- | Instance attribute.
--method_name(args, kwargs)-- | Instance method. Only args / kwargs referred to in the subseqeunt documentation are noted. Signature should be inspected for full parameters.
---classmethod_name()--- | Class method or static method.
----global_constant_name---- | Global constant.

## Issues

Please use the project's [issue page](https://github.com/maread99/pyroids/issues) to report any issues.

## Contact

[Marcus Read](mailto:marcusaread@gmail.com)
[Marcus Read](mailto:marcusaread.gh@proton.me)
Loading