liballeg / allegro5

The documentation for the al_acknowledge_resize uses 1st person to refer to the reader as "the user." This was confusing at first because a lot of the docs are in 2nd person "you should..." and so I thought "the user" referred to the person using your program.

To enhance clarity and maintain consistency with the rest of the doc style, this should be updated to use the second-person perspective.

Currently:

allegro5/docs/src/refman/display.txt

Lines 535 to 547 in 29cc1a8

    
           ### API: al_acknowledge_resize 
        
           When the user receives a [resize event][ALLEGRO_EVENT_DISPLAY_RESIZE] 
        
           from a resizable display, if they wish the display to be resized they 
        
           must call this function to let the graphics driver know that it can now 
        
           resize the display. Returns true on success. 
        
           Adjusts the clipping rectangle to the full size of the backbuffer. This also 
        
           resets the backbuffers projection transform to default orthographic transform 
        
           (see [al_use_projection_transform]). 
        
           Note that a resize event may be outdated by the time you acknowledge it; 
        
           there could be further resize events generated in the meantime.

Suggestion:

When receiving a resize event from a resizable display, you must call this function to let the graphics driver know that it can now resize the display. Returns true on success.
Adjusts the clipping rectangle to the full size of the backbuffer. This also resets the backbuffer's projection transform to the default orthographic transform (see al_use_projection_transform).
Note that Also, a resize event may be outdated by the time you acknowledge it; there could be further resize events generated in the meantime.

ChatGPT:

the shift is made from a more formal and detached tone (referring to the user as "the user") to a more engaging and user-friendly tone by directly addressing the API user as "you." This change aims to create a sense of direct communication and make the documentation more approachable for developers.

agree 👍

I believer "the user" is third person. Also consider using "the caller" or "the programmer" to distinguish from the end-user.

	### API: al_acknowledge_resize

	When the user receives a [resize event][ALLEGRO_EVENT_DISPLAY_RESIZE]
	from a resizable display, if they wish the display to be resized they
	must call this function to let the graphics driver know that it can now
	resize the display. Returns true on success.

	Adjusts the clipping rectangle to the full size of the backbuffer. This also
	resets the backbuffers projection transform to default orthographic transform
	(see [al_use_projection_transform]).

	Note that a resize event may be outdated by the time you acknowledge it;
	there could be further resize events generated in the meantime.

Doc style inconsistent in `al_acknowledge_resize`