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

MooseDocs code snippet file paths must be prefaced by folder to avoid ambiguity #29543

Open
GiudGiud opened this issue Dec 14, 2024 · 0 comments
Labels
P: normal A defect affecting operation with a low possibility of significantly affects. T: defect An anomaly, which is anything that deviates from expectations.

Comments

@GiudGiud
Copy link
Contributor

Bug Description

It is very common to add "Function" or "Scaled" or "Parsed" in front of an object name to indicate the functionality has been augmented in a new object in an applicaiton.
However if the Moose documentation has a snippet like this:

!listing Object.C

this causes an ambiguity as both XYZObject.C and Object.C match the regex

Steps to Reproduce

Have two objects, one of them being named after the other with a prefix
Have a snippet / listing using the name of the other without the folder

Impact

Breaks doco on the application

[Optional] Diagnostics

No response

@GiudGiud GiudGiud added T: defect An anomaly, which is anything that deviates from expectations. P: normal A defect affecting operation with a low possibility of significantly affects. labels Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P: normal A defect affecting operation with a low possibility of significantly affects. T: defect An anomaly, which is anything that deviates from expectations.
Projects
None yet
Development

No branches or pull requests

1 participant