Documentation: Add information about "return" value to all keywords and overall library documentation update

[mikahanninen]

All keywords should have a clear indication of the content of the keyword return value.

Library documentation should contain

• more refined examples on the library keyword usage
• any details (can be links) on library features

Keyword documentation should contain

• clear description on keyword function
• description of the specific exceptions on the keyword (if any)
• keyword usage example (as close to real world usage as possible)
• keyword parameter and return value descriptions

List of libraries

• [x] Archive | Archiving TAR and ZIP files
• [ ] Browser.Selenium | Control browsers and automate the web
• [ ] Browser.Playwright | Newer way to control browsers
• [ ] Cloud.AWS | Use Amazon AWS services
• [ ] Cloud.Azure | Use Microsoft Azure services
• [ ] Cloud.Google | Use Google Cloud services
• [x] #348
• [x] Database | Interact with databases
• [ ] Desktop | Cross-platform desktop automation
• [ ] Desktop.Clipboard | Interact with the system clipboard
• [ ] Desktop.OperatingSystem | Read OS information and manipulate processes
• [ ] Desktop.Windows | Automate Windows desktop applications
• [ ] Dialogs | Request user input during executions
• [ ] Email.Exchange | E-Mail operations (Exchange protocol)
• [ ] Email.ImapSmtp | E-Mail operations (IMAP & SMTP)
• [ ] Excel.Application | Control the Excel desktop application
• [x] Excel.Files | Manipulate Excel files directly
• [x] FileSystem | Read and manipulate files and paths
• [x] FTP | Interact with FTP servers
• [x] HTTP | Interact directly with web APIs
• [x] Images | Manipulate images
• [ ] JavaAccessBridge | Control Java applications
• [x] JSON | Manipulate JSON objects
• [x] Notifier | Notify messages using different services
• [ ] Outlook.Application | Control the Outlook desktop application
• [x] #334
• [ ] Robocorp.Process | Use the Robocorp Process API
• [ ] Robocorp.WorkItems | Use the Robocorp Work Items API
• [ ] Robocorp.Vault | Use the Robocorp Secrets API
• [ ] Salesforce | Salesforce operations
• [ ] SAP | Control SAP GUI desktop client
• [ ] Tables | Manipulate, sort, and filter tabular data
• [ ] Tasks | Control task execution
• [ ] Twitter | Twitter API interface
• [ ] Windows | Alternative library for Windows automation
• [ ] Word.Application | Control the Word desktop application

[cmin764]

👌🏼 Totally agree + -> <return_type> from the function annotation/typing perspective to be exhaustive here.

And since we're at it and because it takes time to visit all these keywords, maybe it will make sense to also check the robotframework code examples in the docstrings for a standard on specifying (or not) the *** Settings *** and *** Tasks *** block headers since these are inconsistent now and producing or not code highlight.

And then fixing the main docs updating workflow logic on not adding automatically *** Tasks *** anymore in every code block encountered in the docstring. (including Python code as well)

[cmin764]

Other potential subtasks (if not already covered these above):

• [ ] ~Make robocorp.com/docs pull, parse and display the :returns: value. (like on Find Text vs Find Text)~
• [ ] ~Having a way of pulling :raises: as well from the docstring to display errors that can be raised in our keyword docs.~
• [ ] Every keyword should have RF and Python examples and should be clear. (RF uses *** Settings *** and *** Tasks ***, optionally *** Keywords *** headers as well and not having robocorp.com/docs adding them automatically as it breaks some edge cases -- linked issue)