Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

needextend does not work depending on file order

See original GitHub issue

If the need and needextension are in the same file, the order between them does not seem to matter and both of the following works.

.. need:: MY_NEED_ID

.. needextend:: MY_NEED_ID
   :status: my-status

.. needextend:: MY_NEED_ID
   :status: my-status

.. need:: MY_NEED_ID

If they are split into different files (that is, need in one and needextend in the other), the file order (based on filename) seems to matter. The needextend does not do any extension, if filenames are changed so that they are alphabetically sorted differently.

Issue Analytics

State:
Created 2 years ago
Comments:6 (2 by maintainers)

Top GitHub Comments

1reaction

danwoscommented, Jun 29, 2021

Ohh sh**, you are right. I have extended my test cases and can confirm this.

The problem is the sphinx event system, which triggers the events per page. So a need on page_1 gets created in docutils node-tree before needextend of page_2 gets executed.

So a solution may be to remove needextend from any events and let the need-creation code take a look into the already fully collected needextend information and execute the modification then per need. This sounds doable.

Thanks for reporting and testing it so deeply. 👍 I’m on it.

0reactions

twodropscommented, Jun 30, 2021

@danwos Works now as expected. Thanks for the quick fix.