Re: [PATCH v5 1/7] strbuf: clarify API boundary
- From
Calvin Wan <calvinwan@google.com>
- Date
- May 11, 2023, 20:03 UTC
- Message-ID
- <CAFySSZBE9PDyRd+fW25awStc3-0Skjj4gqnR-FZQy23vry1RtQ@mail.gmail.com>
- In-Reply-To
- <CAPig+cSTVbvyUOOoVrsTS8t4VSoCbVRoA=i6j0_4KZX5ZTt34Q@mail.gmail.com>
Show 14 quoted lines
> Sorry, I meant to send a follow-up to my previous email[1] but forgot. > In particular, I wanted to say that I think the second part of the > above comment (the "however" and everything which follows) ought to be > dropped since it will become stale once those "older functions" are > finally removed; it is likely nobody will remember to update this > comment. So, the above could rewritten something like this: > > /* > * NOTE FOR STRBUF DEVELOPERS > * > * strbuf is a low-level primitive; as such it should interact only > * with other low-level primitives. Do not introduce new functions > * which interact with higher-level APIs. > */
I agree that it'll probably be forgotten about so your suggested documentation sounds better. If others don't have any more comments on the other patches, I'll reroll just this patch.