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

Consider inheritence when resolving :meth:foo #272

Open
shimizukawa opened this issue Jan 2, 2015 · 2 comments
Open

Consider inheritence when resolving :meth:foo #272

shimizukawa opened this issue Jan 2, 2015 · 2 comments
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature

Comments

@shimizukawa
Copy link
Member

In the below, it would be great for B.bar to resolve the reference to A.foo:

#!python
class A(object):
    def foo(self):
        """foo doc"""

class B(A):
    def bar(self):
        """Calls :meth:`foo`."""
        self.foo()

If 'B' explicitly adds 'foo' or uses :inherited-members:, it will resolve to B.foo, but pulling down the inherited member doc text into B's isn't always desired. Many times I want to reference a single, canonical definition of 'foo', the one on A.


@shimizukawa shimizukawa added this to the 1.x milestone Jan 2, 2015
@shimizukawa shimizukawa added type:enhancement enhance or introduce a new feature extensions:autodoc labels Jan 2, 2015
@shimizukawa
Copy link
Member Author

From Georg Brandl on 2009-11-08 15:33:23+00:00

While this requires a bit of work (and won't scale to non-autodoc docs), I think it should be possible to implement.

Setting milestone to 1.1 for now.

@shimizukawa
Copy link
Member Author

From Georg Brandl on 2011-01-06 20:03:32+00:00

Not yet.

@tk0miya tk0miya modified the milestones: 1.x, 2.0.0 Oct 6, 2018
@tk0miya tk0miya modified the milestones: 2.0.0, 2.1.0 Feb 13, 2019
@tk0miya tk0miya modified the milestones: 2.1.0, 2.2.0 Jun 1, 2019
@tk0miya tk0miya modified the milestones: 2.2.0, 2.3.0 Aug 18, 2019
@tk0miya tk0miya modified the milestones: 2.3.0, 2.4.0 Dec 8, 2019
@tk0miya tk0miya modified the milestones: 2.4.0, 3.0.0 Feb 7, 2020
@tk0miya tk0miya modified the milestones: 3.0.0, 3.1.0 Mar 14, 2020
@tk0miya tk0miya modified the milestones: 3.1.0, 3.2.0 May 30, 2020
@tk0miya tk0miya modified the milestones: 3.2.0, 3.3.0 Aug 2, 2020
@tk0miya tk0miya modified the milestones: 3.3.0, 4.0.0 Oct 29, 2020
@tk0miya tk0miya modified the milestones: 4.0.0, 4.1.0 Apr 4, 2021
@tk0miya tk0miya removed this from the 4.1.0 milestone Jul 10, 2021
@tk0miya tk0miya added this to the 4.2.0 milestone Jul 10, 2021
@tk0miya tk0miya modified the milestones: 4.2.0, 4.3.0 Sep 12, 2021
@tk0miya tk0miya modified the milestones: 4.3.0, 4.4.0 Nov 8, 2021
@tk0miya tk0miya modified the milestones: 4.4.0, 5.0.0 Jan 15, 2022
@tk0miya tk0miya modified the milestones: 5.0.0, 5.x May 2, 2022
@AA-Turner AA-Turner modified the milestones: 5.x, some future version May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

3 participants