Documentation outdated for `printline()`

Open Beginner friendly
#32 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start by reviewing commit 4251e7957e22f4596c95cfd1adadcd92e79ac4b and the SE3 documentation describing printline(file=None). Check how documentation for strline() is generated or built, update the outdated printline guidance and ensure strline() is documented, then rebuild or inspect the resulting documentation.

Written by the indexing model from the issue text.

Description

enhancement

Commit 4251e7957e22f4596c95cfd1adadcd92e79ac4b8 seems to have added the strline() function for getting string representations as a replacement for printline(file=None).

Documentation for SE3 still suggests printline() will output a string when supplied with file=None:

printline

Documentation for the new strline() function also doesn't seem to have been built.

Dominant language
Python
Stars
641
Forks
102
Avg merge
1d 18h
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rai-opensource/spatialmath-python

All issues in rai-opensource/spatialmath-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.