Coder Social home page Coder Social logo

Comments (2)

sdushantha avatar sdushantha commented on July 22, 2024

This man page looks really good! I think your man page is much easier to understand compared to the --help output we currently have.

I do have some minor suggestions for the man page though:

  1. Instead of separating the short command and the long command with a pipe, wouldn't it better to use a comma instead?
  2. Regarding the --text flag, you added a small note where it says (default: html). I find this a little misleading as it could indicate that --text by default has the value of html, but the user can change that by using --text SOMETHING, which is not how tmpmail currently works.

I have no knowledge of man page conventions so please do let me know my suggestions go against the man page conventions.

from tmpmail.

GReagle avatar GReagle commented on July 22, 2024

Thank you for your feedback sdushantha. I am glad that you like it. I will create a fork and pull request for it. Yes you're right about the comma separating the options. I reworded the --text description to try to resolve the ambiguity.

from tmpmail.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.