search

Flow-Launcher / Flow.Launcher.Plugin.PythonTemplate

A python language template for building Flow Launcher plugin
MIT License
10 stars 3 forks source link

DOC: give more information about each template file #6

Closed deefrawley closed 3 years ago

deefrawley commented 3 years ago

As part of improving the Python plugin documentation I have expanded the template README.md to give information about the purpose of each file in the template. Please review and ensure my descriptions and comments are accurate as per the original intent of the template.

deefrawley commented 3 years ago

Changes made. I did keep the requirements.txt section only as it is a good reminder to developers that users need to install the packages themselves (I'm hoping this will help with user issues as it should be the first question asked - it has caught me out before)

deefrawley commented 3 years ago

What did you mean by these?

Zeroto521 commented 3 years ago
  • add the blank line, a subject line with < 80 chars

The rules to make doc become more readable, add the blank line and a line word not too long.

deefrawley commented 3 years ago

Sorry still don't know what you mean. What rules? Where should a blank line go and what is a subject line?

Zeroto521 commented 3 years ago

Sorry still don't know what you mean. What rules? Where should a blank line go and what is a subject line?

Well, you should learn from the changing.

deefrawley commented 3 years ago

Thanks for your patience Zero - I don't use git daily so am still learning how to create and update PR's. I have pushed the changes and I'm hoping this is what needed. If not, I'm available on the Discord to discuss.