Skip to content

Conversation

@frankzengjj
Copy link
Contributor

What changes are being made and why?

closes #7911

Replaces real Task class with a dedicated TestClass that implements all annotations to generate the most complex markdown. This ensures accurate coverage of plugin documentation rendering


How the changes have been QAed?

I created a unit test class TestTaskDocumentationTest that generate the markdown and run the test locally. Also, I printed the markdown output and visually inspected it.


Setup Instructions

none. Just need to run the test.

@MilosPaunovic MilosPaunovic requested review from a team and fhussonnois April 17, 2025 07:48
Copy link
Member

@fhussonnois fhussonnois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @frankzengjj thank you very much for the contribution.

The idea behind the issue is also to replace existing tests from the DocumentationGeneratorTest class.

Could you please :

merge your new class TestTaskDocumentationTest with DocumentationGeneratorTest .
remove existing test methods based on core tasks (e.g., tasks, dags, returnDoc, defaultBool. Set);
also, you need to add some tests for testing deprecated plugins, or properties. For doing that, you can create a new class TestTaskWithDeprecated - for this you can have a look to the existing test DocumentationGeneratorTest#echo.
Thank you

@brian-mulier-p
Copy link
Member

brian-mulier-p commented Apr 22, 2025

Also, @frankzengjj are you using the generated markdowns on your side?
We replaced every usage of it with a json-schema based implementation instead to have proper model and do the design directly in the front-end (doc, in-editor doc, ...) so I think it will be removed somedays so I'm not sure it's worth investing more time on it

@frankzengjj
Copy link
Contributor Author

Thank you @fhussonnois and @brian-mulier-p for all the feedback and comment I will look into this.

@MilosPaunovic
Copy link
Member

Hey @frankzengjj, are there any updates on this?

@MilosPaunovic MilosPaunovic added kind/external Pull requests raised by community contributors area/backend Needs backend code changes labels Oct 22, 2025
@loicmathieu
Copy link
Member

Closing this PR as we haven't heard back from the contributor for 2 months.
Please don't hesitate to reopen it when all feedback has been taken care of, if you still want to work on it.

@loicmathieu loicmathieu closed this Nov 6, 2025
@github-project-automation github-project-automation bot moved this from To review to Done in Pull Requests Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/backend Needs backend code changes kind/external Pull requests raised by community contributors

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Create a test class to test plugin documentation

5 participants