docs(help): write all docstrings in the imperative

Author: marcuscaisey

doc/please.txt

@@ -125,7 +125,7 @@ command to get you started.
 Lua module: please                                                    *please*
 
 setup({opts})                                                 *please.setup()*
-    Updates the configuration with the provided {opts}. Should only be called
+    Update the configuration with the provided {opts}. Should only be called
     if you want to change the defaults which are shown below.
 
     Example: >lua
@@ -141,9 +141,9 @@ setup({opts})                                                 *please.setup()*
                   history items to store for each repository.
 
 build()                                                       *please.build()*
-    If the current file is a `BUILD` file, builds the target which is under
-    the cursor. Otherwise, builds the target which takes the current file as
-    an input.
+    If the current file is a `BUILD` file, build the target which is under the
+    cursor. Otherwise, build the target which takes the current file as an
+    input.
 
 run()                                                           *please.run()*
     If the current file is a `BUILD` file, run the target which is under the
@@ -199,27 +199,27 @@ history()                                                   *please.history()*
     again.
 
 clear_history()                                       *please.clear_history()*
-    Clears the command history for the current repository.
+    Clear the command history for the current repository.
 
 set_profile()                                           *please.set_profile()*
-    Sets the profile that will be used by |please.build()|, |please.run()|,
+    Set the profile that will be used by |please.build()|, |please.run()|,
     |please.test()|, |please.debug()|, and |please.command()|. Profiles will
     be searched for in `/etc/please`, `~/.config/please`, and the current
     repository.
 
 maximise_popup()                                     *please.maximise_popup()*
-    Maximises the popup which was most recently quit or minimised.
+    Maximise the popup which was most recently quit or minimised.
 
 jump_to_target()                                     *please.jump_to_target()*
-    Jumps to the location of the target which takes the current file as an
+    Jump to the location of the target which takes the current file as an
     input.
 
     The cursor will be moved to where the target is created if it can be found
     which should be the case for all targets except for those with names which
     are generated when the `BUILD` file is executed.
 
 look_up_target()                                     *please.look_up_target()*
-    Looks up a target by its build label and jumps to its location. If the
+    Look up a target by its build label and jumps to its location. If the
     cursor is already on a build label, then this will be used. Otherwise,
     you'll be prompted for one.
 

lua/please.lua

@@ -34,8 +34,8 @@ local config = {
 ---@class please.Opts
 ---@field max_history_items integer? The maximum number of history items to store for each repository.
 
----Updates the configuration with the provided {opts}. Should only be called if you want to change the defaults which
----are shown below.
+---Update the configuration with the provided {opts}. Should only be called if you want to change the defaults which are
+---shown below.
 ---
 ---Example:
 ---```lua
@@ -197,8 +197,8 @@ local function get_repo_root(path)
   return nil, "Couldn't locate the repo root. Are you sure you're inside a plz repo?"
 end
 
----If the current file is a `BUILD` file, builds the target which is under the cursor. Otherwise, builds the target
----which takes the current file as an input.
+---If the current file is a `BUILD` file, build the target which is under the cursor. Otherwise, build the target which
+---takes the current file as an input.
 function M.build()
   logging.log_call('please.build')
 
@@ -441,7 +441,7 @@ function M.history()
   end)
 end
 
----Clears the command history for the current repository.
+---Clear the command history for the current repository.
 function M.clear_history()
   logging.log_call('please.clear_history')
 
@@ -459,7 +459,7 @@ function M.clear_history()
   end)
 end
 
----Sets the profile that will be used by [please.build()], [please.run()], [please.test()], [please.debug()], and
+---Set the profile that will be used by [please.build()], [please.run()], [please.test()], [please.debug()], and
 ---[please.command()]. Profiles will be searched for in `/etc/please`, `~/.config/please`, and the current repository.
 function M.set_profile()
   logging.log_call('please.profile')
@@ -510,7 +510,7 @@ function M.set_profile()
   end)
 end
 
----Maximises the popup which was most recently quit or minimised.
+---Maximise the popup which was most recently quit or minimised.
 function M.maximise_popup()
   logging.log_call('please.maximise_popup')
   if runner.current then
@@ -520,7 +520,7 @@ function M.maximise_popup()
   end
 end
 
----Jumps to the location of the target which takes the current file as an input.
+---Jump to the location of the target which takes the current file as an input.
 ---
 ---The cursor will be moved to where the target is created if it can be found which should be the case for all targets
 ---except for those with names which are generated when the `BUILD` file is executed.
@@ -540,7 +540,7 @@ function M.jump_to_target()
   end)
 end
 
----Looks up a target by its build label and jumps to its location. If the cursor is already on a build label, then this
+---Look up a target by its build label and jumps to its location. If the cursor is already on a build label, then this
 ---will be used. Otherwise, you'll be prompted for one.
 ---
 ---The cursor will be moved to where the target is created if it can be found which should be the case for all targets