remove-high-level-inner-classes.xsl:27-28: Create...

[0pdd]

The puzzle 1249-cbc24ee5 from #1249 has to be resolved:

eo/eo-maven-plugin/src/main/resources/org/eolang/maven/pre/remove-high-level-inner-classes.xsl

Lines 27 to 28 in f26ee33

	@todo #1249:90min Create xmir2xmir tests. This tests should be represented in yaml file and contain xsls,
	input(xmir) and output(xmir) sections. Add link to corresponding xmir2xmir test here as documentation -->

The puzzle was created by Yegor Bugayenko on 15-Jul-24.

Estimate: 90 minutes, role: DEV.

If you have any technical questions, don't ask me, submit new tickets instead. The task will be "done" when the problem is fixed and the text of the puzzle is removed from the source code. Here is more about PDD and about me.

[github-actions]

@0pdd thanks for the report, here is a feedback:

• The todo message is not clear about the location or format of the yaml file that should contain the tests. It could be improved by specifying where the file should be located or what its name should be.
• The instruction to 'add link to corresponding xmir2xmir test here as documentation' is vague. It's not clear where 'here' is. This could be clarified by specifying where exactly the link should be added.
• The todo doesn't specify what 'xmir2xmir tests' are or why they're needed. This could be improved by providing a brief explanation of these tests or linking to some documentation about them.

Please fix the bug report in order it to get resolved faster.
Analyzed with gpt-4

[0pdd]

@0pdd thanks for the report, here is a feedback: * The todo message is not clear about the location ...

I see you're talking to me, but I can't reply since I'm not a chat bot.

[levBagryansky]

@maxonfjvipon me

[levBagryansky]

@yegor256 let's transfer it to xax repo. I would like to create alternative yaml test cases:

# yaml
---
xsls:
  - /org/eolang/maven/pre/align-test-classes.xsl
before:
  <Some ML>
after:
  <Another xml>

Such tests would extend documentation of xsl's.

[yegor256]

@maxonfjvipon please, help here

[levBagryansky]

@maxonfjvipon Can you transfer?

[maxonfjvipon]

@levBagryansky why do you want to create xmir2xmir test?

[levBagryansky]

@maxonfjvipon I believe that code examples in comments are bad decision (they lose relevance quickly). It is much better to document them via tests.

[maxonfjvipon]

@levBagryansky comparing XML just by simple text matching is a bad idea because of a lot of reasons, for example attributes can switch places and so on. That's why we use XPATH and that's the main purpose of XAX repo

[levBagryansky]

@maxonfjvipon
It's definitely better than writing input/output in the comments. Updating xsl that has such test, programmer will update it's test.
But perhaps the corresponding infra for test should be in other place.

[maxonfjvipon]

@levBagryansky comments with documentation in XSL are desirable but not mandatory. You're right - the main "documentation" is tests. But we already have mechanism of XML validation - XPATH, we also have infrastructure for it in eo-runtime.

[levBagryansky]

@maxonfjvipon We write such input/output in the comments. Thus, xax does not fit for such cases

[maxonfjvipon]

@levBagryansky as I said - input/output is not mandatory, you should write at least "something" so next user understand what the transformation does

[levBagryansky]

@yegor256 please help

[0pdd]

The puzzle 1249-cbc24ee5 has disappeared from the source code, that's why I closed this issue.