Skip to content

Inconsistency in traceability report #401

Description

@ayankuma

Description

The traceability report is inconsistent while using MD heading style vs RST heading style. The inconsistency is seen only with the first item

Steps to Reproduce

Consider the following tmp.rst

This is the main heading                                                                 
========================                                                                 
                                                                                         
The following are the requirements related to domain creation.                  
                                                                                         
Item 1 heading                                                                           
##############                                                                           
                                                                                         
`XenSSR~item1~1`                                                                         
                                                                                         
Description:                                                                             
Item 1 descrip.                                                                          
                                                                                         
Rationale:                                                                               
Item 1 rationale.                                                                        
                                                                                         
Item 2 heading                                                                           
##############                                                                           
                                                                                         
`XenSSR~item2~1`                                                                         
                                                                                         
Description:                                                                             
Item 2 descrip.                                                                          
                                                                                         
Rationale:                                                                               
Item 2 rationale.                                                                        
                                                                                         
Item 3 heading                                                                           
##############                                                                           
                                                                                         
`XenSSR~item3~1`                                                                         
                                                                                         
Description:                                                                             
Item 3 descrip.                                                                          
                                                                                         
Rationale:                                                                               
Item 3 rationale.                                                                        

The traceability report looks like. This is correct and what we expect.
Screenshot 2024-03-05 at 19 31 48

However, when we use RST heading styles ie (the below file)

This is the main heading                                                                 
========================                                                                 
                                                                                         
The following are the requirements related to domain creation.                  
                                                                                         
Item 1 heading                                                                           
--------------
                                                                                         
`XenSSR~item1~1`                                                                         
                                                                                         
Description:                                                                             
Item 1 descrip.                                                                          
                                                                                         
Rationale:                                                                               
Item 1 rationale.                                                                        
                                                                                         
Item 2 heading                                                                           
--------------
                                                                                         
`XenSSR~item2~1`                                                                         
                                                                                         
Description:                                                                             
Item 2 descrip.                                                                          
                                                                                         
Rationale:                                                                               
Item 2 rationale.                                                                        
                                                                                         
Item 3 heading                                                                           
--------------
                                                                                         
`XenSSR~item3~1`                                                                         
                                                                                         
Description:                                                                             
Item 3 descrip.                                                                          
                                                                                         
Rationale:                                                                               
Item 3 rationale.                                                                        

The traceability report looks like this
Screenshot 2024-03-05 at 19 35 05

Expected behavior

The issue is that for the first item, it renders the heading. We don't want this. Instead we expect that it should render the tags as seen for item2 and item3.
In other words with RST header style, the rendering should be similar to the markdown header style.

Environment

  • OFT: This is the latest master.
  • OS: [Ubuntu 20.04]

Additional context

Add any other context about the problem here.

Activity

  1. self-assigned this
    on Oct 9, 2026
  2. added theissue type on Oct 9, 2026
  3. added a commit that references this issue on Oct 9, 2026
  4. redcatbear commented on Oct 9, 2026

    @redcatbear
    Collaborator

    Hi @ayankuma, I was not able to reproduce the issue with the current version (4.11.0, unreleased) of OFT. Looks like the bug is fixed. But I added a regression test in #628. Could you please take a look if that test correctly reproduces your scenario?

  5. added a commit that references this issue on Oct 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions