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

Document @since in the Rules' Wiki #528

Closed
paulo-ferraz-oliveira opened this issue Sep 10, 2020 · 4 comments
Closed

Document @since in the Rules' Wiki #528

paulo-ferraz-oliveira opened this issue Sep 10, 2020 · 4 comments

Comments

@paulo-ferraz-oliveira
Copy link
Collaborator

At least for the latest versions available, in https://github.com/inaka/elvis_core/wiki/Rules. Kind of like @since 0.7.0.

Try to find a way to properly document the past for the other rules.

@elbrujohalcon, should we get rid of "Old format" in the Wiki? We can probably create a section to help developers migrate, but I think the semantics used (these days, using maps) is pretty self-explanatory.

@paulo-ferraz-oliveira paulo-ferraz-oliveira self-assigned this Sep 10, 2020
@elbrujohalcon
Copy link
Member

Yeah… the old format is clearly not used anymore anywhere… We could remove it from everywhere.

@elbrujohalcon
Copy link
Member

And @since seems like a really nice thing, but retrofitting it to account for all rules… I think it would be too much work for no gain. We can start with @since 0.7.0 for all rules.

@paulo-ferraz-oliveira
Copy link
Collaborator Author

Yeah… the old format is clearly not used anymore anywhere… We could remove it from everywhere.

Done. There's old_configuration_format (which is "by default") so it shouldn't be hard for consumers to know there's something wrong.

@paulo-ferraz-oliveira
Copy link
Collaborator Author

As for since I went back to 0.4.0 (I just compared tags, in Git, so it was easy) and now we have it: https://github.com/inaka/elvis_core/wiki/Rules/_compare/7c99460d686073000d98b968ecb89cf507ba9359...fb84866eed10a4691cdd280aeb6def100a70f1a1.

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

No branches or pull requests

2 participants