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

[DOCS]: need to add documentation for extract line numbers in metrics #1744

Closed
2 tasks done
shahzebsiddiqui opened this issue Apr 3, 2024 · 2 comments · Fixed by #1781
Closed
2 tasks done

[DOCS]: need to add documentation for extract line numbers in metrics #1744

shahzebsiddiqui opened this issue Apr 3, 2024 · 2 comments · Fixed by #1781
Assignees
Labels
documentation documentation fix

Comments

@shahzebsiddiqui
Copy link
Member

shahzebsiddiqui commented Apr 3, 2024

Documentation Link

https://buildtest.readthedocs.io/en/devel/writing_buildspecs/metrics.html

Issue Description

@Xiangs18 can you please add docs for this PR #1725

Post question in Slack

  • I agree that I posted my question in slack before creating this issue

Is there an existing issue

  • I confirm there is no existing issue for this issue
@shahzebsiddiqui shahzebsiddiqui added the documentation documentation fix label Apr 3, 2024
@shahzebsiddiqui shahzebsiddiqui self-assigned this Apr 3, 2024
@Xiangs18
Copy link
Collaborator

Should I start a new section in Docs?
I assume file_regex would required some documentation as well?

@shahzebsiddiqui
Copy link
Member Author

Docs

Yes just add this as a new subsection after https://buildtest.readthedocs.io/en/devel/writing_buildspecs/metrics.html#metrics-with-regex-type-via-re. You can have one section for extracting line number and use both file_regex and regex. If you look at the content of this page, we already cover file_regex in the example so its not required to just have a section to explain what file_regex is. This is already covered in the page. I just want you to document how one can extract a particular line using the linenum property.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation fix
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants