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.

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

[Documentation] Docstrings in game template files are outdated #3387

Open
InspectorCaracal opened this issue Dec 31, 2023 · 0 comments
Open
Labels
documentation Issue with wiki or docstrings.

Comments

@InspectorCaracal
Copy link
Contributor

Existing page / new

https://github.com/evennia/evennia/blob/main/evennia/game_template/typeclasses/objects.py

Documentation issue

The module docstring only mentions the Object typeclass and describes the solution for sharing inheritance that was necessary before ObjectParent was implemented into the game directory.

In addition, the docstring for the Object typeclass itself repeatedly mentions BaseObject, which doesn't exist, and gives what I assume is either a very, very old class path of src.object.objects or is using an unclear shorthand.

Suggested solution

The docstrings should be thoroughly reviewed and updated to match the existing state of evennia

@InspectorCaracal InspectorCaracal added the documentation Issue with wiki or docstrings. label Dec 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue with wiki or docstrings.
Projects
None yet
Development

No branches or pull requests

1 participant