Bugzilla

Hi Myeongjun :)

Thanks for making progress on this issue! So here's a method that you might want to take a look at: https://bugzilla.mozilla.org/show_bug.cgi?id=1633909#c0

We will have to change how the descriptions are setup and built in Perfdocs. Here's what I'm thinking will need to be done:
1.  Add a new method (called something like `build_test_description`) to the framework gatherer (RaptorGatherer and FrameworkGatherer), that will be responsible for providing a documentation chunk for that test.
    1. The `build_test_description` would take the test name, and a given description if it exists as arguments, and return either (1) a documentation chunk (like we have now, - a block of text), or (2) a new file that contains the test description information.
2. Use this method here to make the framework gatherers responsible for providing the documentation chunk (for a given test): https://searchfox.org/mozilla-central/source/tools/lint/perfdocs/generator.py#100-112
    1. To get access to the framework gatherer from the generator you'll need to make a method in the verifier and gatherer that would return the correct framework gatherer.

It may be best to implement (1) and (2) and keep the same documentation format for now. We can change the structure afterwards using this new feature.

What I'm thinking we can do with it is return nothing when asked to build a test description, and when nothing is returned, just add the test to a list of tests that will be shown under the suite description (like in the bug description I linked above). Otherwise, if a description is returned and it isn't a new page, add it underneath the test name in that list.

Let me know if anything here isn't clear or you have nay questions! :)

Hi Myeongjun :)

Thanks for making progress on this issue! So here's a method that you might want to take a look at: https://bugzilla.mozilla.org/show_bug.cgi?id=1633909#c0

We will have to change how the descriptions are setup and built in Perfdocs. Here's what I'm thinking will need to be done:
1.  Add a new method (called something like `build_test_description`) to the framework gatherer (RaptorGatherer and FrameworkGatherer), that will be responsible for providing a documentation chunk for that test.
    1. The `build_test_description` would take the test name, and a given description if it exists as arguments, and return either (1) a documentation chunk (like we have now, - a block of text), or (2) a new file that contains the test description information.
2. Use this method here to make the framework gatherers responsible for providing the documentation chunk (for a given test): https://searchfox.org/mozilla-central/source/tools/lint/perfdocs/generator.py#100-112
    1. To get access to the framework gatherer from the generator you'll need to make a method in the verifier and gatherer that would return the correct framework gatherer.

It may be best to implement (1) and (2) and keep the same documentation format for now. We can change the structure afterwards using this new feature.

What I'm thinking we can do with it is return nothing when asked to build a test description, and when nothing is returned, just add the test to a list of tests that will be shown under the suite description (like in the bug description I linked above). Otherwise, if a description is returned and it isn't a new page, add it underneath the test name in that list.

Let me know if anything here isn't clear or you have any questions! :)