astropy / astropy/sphinx-automodapi

Strip unicode literal formatting from attribute documentation

Open
#57 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

On some doc pages for classes (and possibly modules)--for example [`Polynomial2D`](http://docs.astropy.org/en/v1.0.3/api/astropy.modeling.polynomial.Polynomial2D.html)--under the "Attribute Documentation" literal values that involve unicode strings display them with the Python 2 style `u'...'` unicode literal syntax. Since in the vast majority of cases users won't care about this, it's just distracting. Since we can't provide a different repr for every possible object that might contain a `str.__repr__` as part of its `__repr__`, a better approach, unfortunately, will be to just run a regexp over the final output when generating the attribute documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the code that generates class or module Attribute Documentation and inspect the final-output formatting path described in the issue. Reproduce the Polynomial2D documentation example and verify that unicode attribute values no longer display Python 2's u'...' prefix.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.