Yes, I think this would be very helpful.
On 19/02/2015 10:17 AM, Ertugrul Söylemez ert...@gmx.de wrote:
What I want to say is that it might be boring to maintain such a
comprehensive help system, but it’s totally worth it, and it’s
wonderful that someone volounteers to do that. BTW it would
Hi,
On 18/02/15 20:20, Kirill Elagin wrote:
Having short reminders instead of long and verbose man pages is _so much
better_. And having context-sensitive help is _absolutely marvelous_.
We could improve the current man-based situation in two ways:
* Have the synopsis section show the
On Mon Feb 16 2015 at 6:22:20 PM Eelco Dolstra eelco.dols...@logicblox.com
wrote:
Note that I removed --help on purpose because I didn't want to maintain
two sets
of option documentation. Invoking man is also what tools like Git do, so
it's
not entirely uncommon.
--
Eelco Dolstra |
What I want to say is that it might be boring to maintain such a
comprehensive help system, but it’s totally worth it, and it’s
wonderful that someone volounteers to do that. BTW it would be nice to
have a generic framework for writing docs and then doing things like
generating man-pages and
On 17 Feb 2015, at 10:34, Eelco Dolstra eelco.dols...@logicblox.com wrote:
Hi,
On 16/02/15 19:53, Ertugrul Söylemez wrote:
Software should be fully documented. If you don't know where the line
between regular users and advanced users is, don't draw one in the
first place.
On 16 Feb 2015, at 19:53, Ertugrul Söylemez ert...@gmx.de wrote:
I believe everything should be documented at least in a technical
manual. But there is nothing wrong with putting a note there:
Regular users should not need to use this command.
I wouldn't be in such a hurry to document
Hi,
On 16/02/15 19:53, Ertugrul Söylemez wrote:
Software should be fully documented. If you don't know where the line
between regular users and advanced users is, don't draw one in the
first place.
It's not so much a question of regular vs. advanced use, but whether something
is a stable
Umm, this is kinda the point that I was making, you were the one who
suggested to write that regular users should use this feature, so I
explained that you can't differentiate between regular and advanced
users to you need to treat all users equally and just document the
feature in a clear
Software should be fully documented. If you don't know where the
line between regular users and advanced users is, don't draw one
in the first place.
It's not so much a question of regular vs. advanced use, but whether
something is a stable interface. If we document a command like
Regarding --register-validity, it's a bit of internal command that I'm
not sure should be documented. But yeah, ‘exportReferencesGraph’
shouldn't refer to it :-)
Well, it is apparently a helpful utility when you change core parts of
NixOS, when you create your own Nix-based distribution or
On 16 Feb 2015, at 17:04, Ertugrul Söylemez ert...@gmx.de
I believe everything should be documented at least in a technical
manual. But there is nothing wrong with putting a note there: Regular
users should not need to use this command.
I wouldn't be in such a hurry to document things
I believe everything should be documented at least in a technical
manual. But there is nothing wrong with putting a note there:
Regular users should not need to use this command.
I wouldn't be in such a hurry to document things in this manner ,
because the basic assumption is if it's
The best way to find out might be to use git blame and see commit history.
On Mon, Feb 16, 2015 at 3:49 PM, Ertugrul Söylemez ert...@gmx.de wrote:
+1 to doc fixes! :-) I'll gladly help with peer review for the content
or whatever I can within the prose capacity :-)
Nobody else? I would
+1 to doc fixes! :-) I'll gladly help with peer review for the content
or whatever I can within the prose capacity :-)
Nobody else? I would just do it, but at the very least I need an
explanation of the missing parts.
signature.asc
Description: PGP signature
+1 to doc fixes! :-) I'll gladly help with peer review for the
content or whatever I can within the prose capacity :-)
Nobody else? I would just do it, but at the very least I need an
explanation of the missing parts.
The best way to find out might be to use git blame and see commit
Hi,
On 16/02/15 16:02, Ertugrul Söylemez wrote:
+1 to doc fixes! :-) I'll gladly help with peer review for the
content or whatever I can within the prose capacity :-)
Nobody else? I would just do it, but at the very least I need an
explanation of the missing parts.
The best way to find
Hi again everybody,
I noticed that the documentation of various Nix tools is incomplete and
often too vague, so I'd like to contribute documentation patches. From
the top of my head the following two flags are currently undocumented:
* `nix-store --register-validity`
* `nix-env --set`
The
+1 to doc fixes! :-) I'll gladly help with peer review for the content or
whatever I can within the prose capacity :-)
On 15 Feb 2015, at 02:57, Ertugrul Söylemez ert...@gmx.de wrote:
Hi again everybody,
I noticed that the documentation of various Nix tools is incomplete and
often too
18 matches
Mail list logo
