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.

Sign up for GitHub

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

Jump to bottom

Close #5977: :var: field do not create a cross-reference … #8638

Merged
merged 2 commits into from Jan 5, 2021
Merged

Close #5977: :var: field do not create a cross-reference … #8638

merged 2 commits into from Jan 5, 2021

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jan 1, 2021

Feature or Bugfix

  • Feature
  • Bugfix

Purpose

  • Since its beginning, :var: field has created a cross-reference to the
    attribute having the same name. It is meaningful only if the attribute
    is documented by py:attribute directive. It means the :var: field
    and :attr: role are almost the same and conflicted. Additionally, the
    cross-reference points incorrect variable if the target is not
    documented.
  • Thus, the cross-reference feature of :var: field is disabled.
  • refs: Instance variables link to other variables of the same name in the project #5977

@tk0miya
test: py domain: Add a testcase for :var: field
9cac200
@tk0miya
Close sphinx-doc#5977: :var: field do not create a cross-reference
918086b 
Since its beginning, `:var:` field has created a cross-reference to the
attribute having the same name.  It is meaningful only if the attribute
is documented by `py:attribute` directive.  It means the `:var:` field
and `:attr:` role are almost the same and conflicted.  Additionally,
the cross-reference points incorrect variable if the target is not
documented.

Thus, the cross-reference feature of `:var:` field is disabled.
@tk0miya tk0miya added type:bug type:enhancement enhance or introduce a new feature domains:py labels Jan 1, 2021
@tk0miya tk0miya added this to the 3.5.0 milestone Jan 1, 2021
@tk0miya tk0miya modified the milestones: 3.5.0, 4.0.0 Jan 1, 2021
@tk0miya tk0miya changed the title @tk0miya Close #5977: :var: field do not create a cross-reference … Close #5977: :var: field do not create a cross-reference … Jan 1, 2021
shimizukawa
shimizukawa approved these changes Jan 3, 2021
View reviewed changes
Copy link
Member

@shimizukawa shimizukawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tk0miya tk0miya merged commit 5ba5602 into sphinx-doc:master Jan 5, 2021
@tk0miya tk0miya deleted the 5977_dont_link_var_field branch January 5, 2021 16:00
This was referenced Mar 6, 2021
Closed
Closed
@tk0miya tk0miya mentioned this pull request Mar 16, 2021
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shimizukawa shimizukawa shimizukawa approved these changes

Assignees
No one assigned
Labels
domains:py type:bug type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
4.0.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tk0miya @shimizukawa