On 09/11/2023 11:13, Alejandro Colomar wrote: > Hi Jonny, > > On Thu, Nov 09, 2023 at 10:13:24AM +0000, Jonny Grant wrote: >> On 09/11/2023 00:29, Alejandro Colomar wrote: >> How about following the style of the other man pages that put the notes about each function below them? (rather than above) >> https://man7.org/linux/man-pages/man3/string.3.html >> >> size_t strlen(const char *s); >> Return the length of the string s. >> >> >> At the moment on string_copying there are // comments on the line above each function. So the presentation of the information is different: >> >> // Copy/catenate a string. >> char *strcpy(char *restrict dst, const char *restrict src); >> char *strcat(char *restrict dst, const char *restrict src); > > The reason for this presentation is that I want to first look at what > they do, and only then look at the function you need to do that. That appears different to the man page convention. It looks odd especially with the extra // that I don't recall other pages having in the description, usually that would be for examples. Consistency is best, but I'll leave it with you. Kind regards Jonny > > So, if you want to copy from a character sequence into a string, you > search for that, and it will tell you what functions you can use for > that (strncat(3) is the only standard one). > > If you want to search for a specific function, you can always search > with '/strncpy'. > > Cheers, > Alex >
