Feature request > Document the --listfixers command line option with Katacoda

[tamere-allo-peter]

📜 Read (and accept) this before

• I am respectful : this is free software and efforts are made on free time, with 💙
• I have looked at the current project roadmap
• I have already looked in current and past issues so I'm sure others did not already push a simlar issue
• I make one single issue per feature request so the team can work efficienlty on it
• I am aware of Unix philosophy : Make each program do one thing well
• When (and if) your feature is implemented, be thnankful and help promote the project by sharing the issue on social networks (twitter, linkedIn, dev.to...) and droppig the url on te issue

❔ Context

• yamlfixer v0.3.9 introduces the --listfixers command line option to list the problems reported by yamllint that yamlfixer knows how to fix.

👉 It would be great to document this with Katacoda.

💡 Proposed solution

• Modify the Katacoda scenario to document this new feature.

[adriens]

Yep, great idea 👍

[tamere-allo-peter]

@adriens How are your calves ?

[adriens]

@tamere-allo-peter : Does --listfixers switch have a short version ? (-l) ❔

[tamere-allo-peter]

Yes, see README or --help :)

[adriens]

👍

[tamere-allo-peter]

@adriens The --listfixes option name was changed a while ago to --listfixers to better represent what it does. So the picture above is not accurate anymore.

[adriens]

@adriens The --listfixes option name was changed a while ago to --listfixers to better represent what it does. So the picture above is not accurate anymore.

OK, can you please drop me a dedicated issue so I upgrade the documentation 🙏

[tamere-allo-peter]

@adriens I don't understand what you want to upgrade besides the image above, since the present issue is precisely about documenting this feature. It being still open means there's no documentation to upgrade.

[adriens]

I mean : documenting a screenshot on the README is not the same thing than documenting it on katacoda 😸

[tamere-allo-peter]

@adriens sorry I talked about the image above only (and btw didn't ask for you to replace it, it was just FYI), not about the demo at the top of the README... Don't worry with this, I don't think doing screenshots/demos before all command line options are implemented is a waste of time. And I've got some new ideas to add as command line options ;)

[adriens]

Got it dude 😸

[adriens]

At a given phasis, we'll have to pay good attention to breaking changes as it may have impact on our tool's popularity 👍

[tamere-allo-peter]

LOL. That's what tests are for ! And yes, they are coming sooner than later...

[adriens]

💟

[tamere-allo-peter]

@adriens : http://www.catb.org/jargon/html/Z/Zawinskis-Law.html