[FFmpeg-cvslog] r11225 - trunk/libavformat/avformat.h

[Michael Niedermayer]

On Mon, Dec 17, 2007 at 09:38:05PM +0100, Diego Biurrun wrote:
> On Mon, Dec 17, 2007 at 12:34:05PM +0100, Michael Niedermayer wrote:
> > On Mon, Dec 17, 2007 at 10:53:07AM +0100, Diego Biurrun wrote:
> > > On Mon, Dec 17, 2007 at 02:38:19AM +0100, Michael Niedermayer wrote:
> > > > On Sun, Dec 16, 2007 at 11:40:05PM +0000, M?ns Rullg?rd wrote:
> > > > > Diego Biurrun <diego at biurrun.de> writes:
> > > > > 
> > > > > > On Sun, Dec 16, 2007 at 10:52:23PM +0000, M?ns Rullg?rd wrote:
> > > > > >> Michael Niedermayer <michaelni at gmx.at> writes:
> > > > > >> 
> > > > > >> > On Sun, Dec 16, 2007 at 06:22:09PM +0100, Diego Biurrun wrote:
> > > > > >> >> On Sat, Dec 15, 2007 at 05:54:59PM +0100, michael wrote:
> > > > > >> >> > 
> > > > > >> >> > Log:
> > > > > >> >> > document how to free the result of av_alloc_format_context()
> > > > > >> >> > 
> > > > > >> >> > --- trunk/libavformat/avformat.h	(original)
> > > > > >> >> > +++ trunk/libavformat/avformat.h	Sat Dec 15 17:54:58 2007
> > > > > >> >> > @@ -569,7 +569,11 @@ int av_open_input_file(AVFormatContext *
> > > > > >> >> > +/**
> > > > > >> >> > + * Allocate an AVFormatContext.
> > > > > >> >> > + * can be freed with av_free() but dont forget to free everything you
> > > > > >> >> > + * explicitly allocated as well!
> > > > > >> >> 
> > > > > >> >> Could you please make an effort to avoid obvious misspellings ("dont")?
> > > > > >> >> It took some work to fix these things up in FFmpeg and it would be a
> > > > > >> >> pity to let it go to waste again.
> > > > > >> >
> > > > > >> > feel free to improve the precommit check script
> > > > > >> 
> > > > > >> I have to say, this attitude of yours is starting to get quite tiresome.
> > > > > >
> > > > > > Very much so.  I don't understand why you are such a complete perfectionist
> > > > > > about what code is acceptable for FFmpeg and at the same time disregard
> > > > > > the quality of the (Doxygen) documentation.
> > > > 
> > > > because "dont" is as readable with as well as without some little speck
> > > > between n and t, buggy, slow, bloated, ... code though has a quite noticeable
> > > > effect, take a look at our bugtracker how many bugs are there about spelling
> > > > and grammer and how many are there about other things
> > > 
> > > There have been numerous (as in infinite) complaints about lack of FFmpeg
> > > documentation, both developer docs and user docs.
> > 
> > lack yes, spelling errors ... no
> > this thread wasnt about lack but spelling errors ...
> 
> This thread is about easy-to-avoid spelling/grammar errors that feel
> wanton and lack of punctuation.  This is a difference for me.

its wanton for you, ignorance for mans and bikeshed for me


> 
> > > "Dont" may be as readable to you as "do not" and maybe it is to others
> > > that have gotten used to reading your prose, but it sure does not extend
> > > to the general case.  Especially not to people with poor English skill.
> > > Unfortunately most readers are not native speakers and have to struggle
> > > quite a bit to understand even good written English.
> > 
> > then why is it that you and mans are the only ones complaining?
> > i dont remember anyone with poor english skill ever complaining. its
> > rather the opposite the ones with good skill complain ...
> > it gives one the feeling that good skill is needed to notice such
> > errors and that comprehensibility isnt part of it ...
> 
> Now that others have spoken it should be clear that good skill is not
> required to notice such errors.

whom of thouse who spoke up lacks good english skill?


>  Good English skill helps to parse bad
> English.  Please do not forget this, people with poor English skills
> generally have much more trouble detecting typos and errors as such and
> still comprehend what is written.
> 
> > > Nevertheless - wantonly - refusing to punctuate is not something that
> > > does not affect readability.  Leaving out periods and commas turns your
> > > prose into a hard-to-decipher mess.  Believe me, I read your stuff, I
> > > have often enough struggled with it.  If this is your preferred way of
> > > writing emails, well, I won't be able to reform you.  But if you write
> > > Doxygen comments etc. this way, then you damage their comprehensibility.
> > 
> > i never intentionally ommited ., from a doxygen comment, that said iam certain
> > you can find many missing, you blame me for my less than perfect english skill
> > ?
> > what is it that you are trying to achive with these attacks? keep me from
> > writing doxy comments and more verbose commit messages? because that frankly
> > is the only thing you might achive
> 
> I am absolutely not trying to blame you for your English skill nor
> attack you.  Nothing could be further from the truth.  I think I made a
> respectful and polite request:
> 
>   Could you please make an effort to avoid obvious misspellings ("dont")?
>   It took some work to fix these things up in FFmpeg and it would be a
>   pity to let it go to waste again.

i just made an effort to reduce the problem, that is i tried to get kwrite to
highlight misspellings
according to
http://bugs.kde.org/show_bug.cgi?id=33857
this feature has been added in KDE4
kwrite KDE4-RC2 (3.97) kwrite in debian depends on kdebase-runtime-data
which itself depends on kdebase-runtime-bin this again depends on
kdebase-runtime-data of version 4:3.96.0-2 which you guessed it doesnt
exist
now if kde/kwrite wouldnt be that bloated i might try to compile it myself
...
pester the idiot debian maintainer if you want to see fewer donts
iam sure you agree that having them highlighted nicely would help me spot
them and thus reduce them ...


> 
> Somehow it all went downhill from there since we're all so prone to
> flamage.  I'll try to be more explicit about what I would and would not
> like to achieve now.
> 
> What I would like to see are simple things that should not require any
> real effort from your side:
> 
> - Capitalize the first word of a sentence.
> - End each sentence with a period.
> - Try to use commas where appropriate.
> - Drop the weird contractions you are so fond of (theres, isnt, dont, ..).
>   This could easily be done by using long forms, which are better style.
> - Avoid a handful of your most common typos (misSunderstand, gUrantee,
>   grammEr, succeS, visSual, immedIATEly, spaTial, ..), I could make a
>   list if you want.
> 
> Note that this would take your English to an entirely new level without
> much work.  I do not expect or request perfection or going out of your
> way to address these issues, just a modicum of effort.

ill try

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Asymptotically faster algorithms should always be preferred if you have
asymptotical amounts of data
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-cvslog/attachments/20071218/a8e29afd/attachment.pgp>