Change README format to Markdown

dsalt / devilspie2

Devilspie2 is a window matching utility, allowing the user to perform scripted actions on windows as they are opened and closed.

GNU General Public License v3.0

132 stars 15 forks source link

Change README format to Markdown #20

Closed jessp01 closed 2 weeks ago

jessp01 commented 5 months ago

Plus some minor phrasing revisions.

dsalt commented 2 weeks ago

I've pulled in some of the minor phrasing revisions and made some other small changes (see e6a0e71). If there are any more which should be made, let's get them done before any conversion to Markdown.

jessp01 commented 2 weeks ago

Hi @dsalt ,

Changes seem fine to me. Two thoughts, however:

Can we use the term input (or the plural form, depending on context) rather than indata? I reckon it's easier to comprehend, personally
With regards to:

Returns TRUE if the window is fullscreen, FALSE otherwise

In all other instances, true and false are used; not very important granted but I do think there's merit to consistency:)

Cheers,

dsalt commented 2 weeks ago

If we're going to replace “indata”, I suggest “parameter”/“parameters” – but, since we should probably do this both in documentation and in message text, I think that it should be done on @sparr's deduplicate_param_count_checking branch (or done once that's merged) as that's already affecting translations.

dsalt commented 2 weeks ago

I've reworked and committed. Looks fine to me right now, but if you see anything which needs fixing or tweaking…