Missed Description for mandatory-home Warning

[volodya-lombrozo]

I'm getting the following warning when I check my xmir:

[mandatory-home WARNING]:0 The +home meta is mandatory, but is absent

I don't have home meta and I don't know what I should put here. Please add more human-readable description to this warning and provide instruction that should be done to fix this warning.

There is how I check the xmir:

final Collection < Defect > defects = new Program(new StrictXmir(this.doc)).defects()
    .stream()
    .collect(Collectors.toList());
if (!defects.isEmpty()) {
    throw new IllegalStateException(
        String.format(
            "XMIR is incorrect: %s, %n%s%n",
            defects,
            this.doc
        )
    );
}

Full xmir:
MethodByte.xmir.txt

[volodya-lombrozo]

Blocks: objectionary/jeo-maven-plugin#946

[volodya-lombrozo]

@yegor256 Can you have a look, please?

[yegor256]

@h1alexbel can you please help here and provide a better error message. I believe, we should say:

The +home meta is mandatory, but is absent (must contain URL of repository where object sources may be found)

[yegor256]

@volodya-lombrozo in can of JEO, I would put there this URL (for all objects): https://github.com/objectionary/jeo-maven-plugin

[volodya-lombrozo]

@h1alexbel can you please help here and provide a better error message. I believe, we should say:

The +home meta is mandatory, but is absent (must contain URL of repository where object sources may be found)

@yegor256 @h1alexbel It should also contain an example of this meta, otherwise, it's impossible to say which child elements the home meta contains.

@yegor256 Can you provide an example, please?

[h1alexbel]

@yegor256 assign me, please

[h1alexbel]

It should also contain an example of this meta, otherwise, it's impossible to say which child elements the home meta contains.

@yegor256 @volodya-lombrozo I suggest we should implement this, in order to resolve this type of problems. For instance, error messages from mandatory-home will contain the link to HTML page with this document: https://github.com/objectionary/lints/blob/gh-pages/_site/0.0.30/mandatory-home-meta.md. WDYT?

[yegor256]

@h1alexbel if we put links to each message of each Defect, it will be pretty noisy for the eo-maven-plugin. Maybe it's better to add an explanation to the Javadoc of the Defect, Program.defects(), and Programs.defects().

[h1alexbel]

@yegor256 Should we add a link to the blog post about XMIR? Or to the XMIR documentation? I think that XMIR documentation suits better for this purpose

[yegor256]

@h1alexbel I suggest we add both links

[h1alexbel]

@yegor256 I will make a PR for this ticket, assign me, please