Improve API documentation #1025
Conversation
alexandra-simeonova
requested review from
bszwarc and
majakurcius
as code owners
alexandra-simeonova
requested review from
hardl,
JohannesDoberer,
marynaKhromova,
maxmarkus,
pekura and
zarkosimic
as code owners
core/src/core-api/i18n.js
Outdated
| @@ -30,7 +30,7 @@ class LuigiI18NManager { | |||
|
|
|||
| /** | |||
| * Gets the current locale. | |||
| * @returns {string} current locale | |||
| * @returns {string}: current locale | |||
There was a problem hiding this comment.
Type definitions cannot be followed by a colon (or from my tests, it works with @returns, but not with @params, probably because the first word after the type is processed too, since it describes the function parameter name).
If you run lerna run docu you see that it is broken. Please fix all occurrences in this file.
docs/luigi-client-api.md
Outdated
| - [Callbacks](#lifecycle˜initlistenercallback) - callback functions for initListener and customMessageListener | ||
| - [Link manager](#linkmanager) - you can use the linkManager instead of an internal router | ||
| - [Split view](#splitview) - allows you to open a micro frontend in the lower part of the content area in a "split screen" view | ||
| - [uxManager](#uxmanager) - functions related to appearance and user interface |
There was a problem hiding this comment.
Appearance meaning the appearance of user interface? Or something else?
There was a problem hiding this comment.
Since Luigi is almost exclusively about user interface, I'd say the first one. Maybe we don't need the word "appearance" here. Thank you 👍
|
|
||
| ##### Parameters | ||
|
|
||
| - `settings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** the settings for the alert |
There was a problem hiding this comment.
Some of the sentences do have dots at the end some don't - but I think it may be this rendering problem you told me about. Also, it's up to you to have / not have them as long as they are consistent :)
There was a problem hiding this comment.
Yes, I tried to add the dots but I get an error from the script which renders the docu 🙁
There was a problem hiding this comment.
So, I removed the dots for consistency.
Co-Authored-By: Barbara Szwarc <[email protected]>
* master: Debug cypress travis issue (SAP#1097) Fix communication from external mf using customMessages (SAP#1081) fix fd-modal mix-up (SAP#1068) who is using luigi in about page (SAP#1077) Add cobrick logo (SAP#1072) who is using luigi button (SAP#1066) Update README.md Update README.md release v0.7.4 (SAP#1069) fix items calculation in more btn of tab nav(SAP#1065) Add valid href to navigation links (SAP#1034) fix runtime error when contextSwitcher is not defined (SAP#1047) Improve API documentation (SAP#1025) Improve authorization doc structure (SAP#1024) Improve Overview page (SAP#1000) Improve application-setup.md (SAP#965) create content guidelines (#877) Documentation fixes (SAP#1003) # Conflicts: # docs/luigi-core-api.md # test/e2e.sh
* update luigi-core-api.md Co-authored-by: Barbara Szwarc <[email protected]>
Description
Changes proposed in this pull request:
Related issue(s)
#1016