<div dir="ltr"><br><br>On Fri, Nov 20, 2020 at 9:38 AM Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de">sebastian.huber@embedded-brains.de</a>> wrote:<br>><br>> On 20/11/2020 17:10, Gedare Bloom wrote:<br>><br>> >> -/**<br>> >> - *  @brief Checks whether is on a valid buffer boundary for the_partition.<br>> >> - *<br>> >> - *  This function returns TRUE if the_buffer is on a valid buffer<br>> >> - *  boundary for the_partition, and FALSE otherwise.<br>> > I think keep these two lines. This function is not so clear without<br>> > thinking through what it means to do pointer arithmetic (subtraction<br>> > and mod).<br>> ><br>> >> - */<br>> >> -RTEMS_INLINE_ROUTINE bool _Partition_Is_buffer_on_boundary (<br>> >> -  void              *the_buffer,<br>> >> -  Partition_Control *the_partition<br>> >> -)<br>><br>> The function name is _Partition_Is_buffer_on_boundary().<br>><br>> The brief description is "Checks whether is on a valid buffer boundary<br>> for the_partition". This sentence is ill formed. If we disregard this,<br>> the only extra information is "valid". So, maybe rename it to<br>> _Partition_Is_buffer_on_valid_boundary().<br>><br>> The "This function returns TRUE if the_buffer is on a valid buffer<br>> boundary for the_partition, and FALSE otherwise." tells you the obvious.<br>><div><br></div><div>It depends on whether "valid boundary" has a good meaning at this level of the code. Adding valid to the function name is helpful. Thanks.</div><div><br></div><div>Just trying to help you pass those code comment density metrics :'D</div><div><br>> --<br>> embedded brains GmbH<br>> Sebastian HUBER<br>> Dornierstr. 4<br>> 82178 Puchheim<br>> Germany<br>> email: <a href="mailto:sebastian.huber@embedded-brains.de">sebastian.huber@embedded-brains.de</a><br>> Phone: +49-89-18 94 741 - 16<br>> Fax:   +49-89-18 94 741 - 08<br>> PGP: Public key available on request.<br>><br>> embedded brains GmbH<br>> Registergericht: Amtsgericht München<br>> Registernummer: HRB 157899<br>> Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler<br>> Unsere Datenschutzerklärung finden Sie hier: <a href="https://embedded-brains.de/datenschutzerklaerung/">https://embedded-brains.de/datenschutzerklaerung/</a><br>><br></div></div>