ansys / ansys/pystk

Missing docstring in magic method

Open
#73 0 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
37
Forks
7
Avg merge
1d 5h
Merged PRs (30d)
19

Description

🐞 **Problem**
Some magic methods like `__setattr__` are not documented. The following log contains a list of files and their lines of code which required a docstring for dunder methods.

Contributor guide

Open the contributing guide

Research direction

The issue refers to a log listing files and line numbers, but that log is not included in the payload. Start by locating the Python files containing undocumented dunder methods, especially __setattr__, and review the surrounding documentation conventions. Done means every method identified by the log has an appropriate docstring.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.