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

c domain: Generate node_id for objects in the right way #7269

Merged
merged 1 commit into from Mar 14, 2020

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Mar 7, 2020

Feature or Bugfix

  • Bugfix
  • Refactoring

Purpose

# by a module name and so easily clash with e.g. section titles
targetname = 'c.' + name
if targetname not in self.state.document.ids:
signode['names'].append(targetname)
Copy link
Member Author

Choose a reason for hiding this comment

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

I think mention in CHANGES is not needed for C domain. Because it might be not official and hidden feature.

.. c:function:: func

ref with `c.func`_

@tk0miya
Copy link
Member Author

tk0miya commented Mar 7, 2020

Note: This will conflict with #7256. I'll update either this or #7256 on merging.

@codecov
Copy link

codecov bot commented Mar 7, 2020

Codecov Report

Merging #7269 into 3.x will increase coverage by 0.02%.
The diff coverage is 94.64%.

Impacted file tree graph

@@            Coverage Diff             @@
##              3.x    #7269      +/-   ##
==========================================
+ Coverage   84.05%   84.08%   +0.02%     
==========================================
  Files         279      280       +1     
  Lines       43222    43256      +34     
  Branches     6299     6299              
==========================================
+ Hits        36329    36370      +41     
+ Misses       5520     5515       -5     
+ Partials     1373     1371       -2
Impacted Files Coverage Δ
tests/test_build_html.py 97.91% <ø> (ø) ⬆️
tests/test_domain_c.py 100% <100%> (ø)
sphinx/domains/c.py 75.13% <88%> (+4.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ef573a...f4c2994. Read the comment docs.

@tk0miya tk0miya merged commit 79e4514 into sphinx-doc:3.x Mar 14, 2020
@tk0miya tk0miya deleted the 6903_cdomain branch March 14, 2020 07:51
@jakobandersen jakobandersen mentioned this pull request Mar 15, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant