Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Document the minimum public API #1060

Merged
merged 9 commits into from
Feb 1, 2021
Merged

Conversation

aibcmars
Copy link
Contributor

@aibcmars aibcmars commented Jan 28, 2021

List initialization, load, and registry API.
Introduce 2 Categories in the documentation

  • Initialization: creation of the main object and its configuration
  • Interaction: user interactions, changes in the visual part of the diagram

it looks like that:
image

closes #593

initial thoughts
@aibcmars aibcmars added documentation Improvements or additions to documentation enhancement New feature or request WIP 🚧 Pull request in progress and/or not ready for review. Used in addition to marking it as draft labels Jan 28, 2021
aibcmars and others added 3 commits January 28, 2021 17:52
Co-authored-by: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
@@ -24,17 +26,22 @@ export interface GlobalOptions {
navigation?: NavigationConfiguration;
}

/**
* @category Initialization
*/
export interface NavigationConfiguration {
/**
* @default false
*/
enabled: boolean;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one is not mandary

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The navigation field in GlobalOptions is already optional.
If the user instantiate this object, the enabled field should be mandatory, else I don't see the point to instantiate this object (or we can not have this field).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, so let's keep it as it is.

Copy link
Member

@csouchet csouchet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a little modification to simplify the reading ^^

@tbouffard tbouffard changed the title [API] minimum public API [DOC] Document the minimum public API Feb 1, 2021
@tbouffard tbouffard removed the WIP 🚧 Pull request in progress and/or not ready for review. Used in addition to marking it as draft label Feb 1, 2021
tbouffard and others added 2 commits February 1, 2021 10:23
Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>
@tbouffard
Copy link
Member

Just a little modification to simplify the reading ^^

@csouchet I have reverted your suggestion in f111757. Because BpmnVisualization is exported by default in its file, we cannot export it directly via a single export directive. This is an issue we already have in bpmn-visualization.ts. If we want to use single export directive, we should not export it as default.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 1, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

0.0% 0.0% Coverage
0.0% 0.0% Duplication

@csouchet
Copy link
Member

csouchet commented Feb 1, 2021

Just a little modification to simplify the reading ^^

@csouchet I have reverted your suggestion in f111757. Because BpmnVisualization is exported by default in its file, we cannot export it directly via a single export directive. This is an issue we already have in bpmn-visualization.ts. If we want to use single export directive, we should not export it as default.

To re-export a default class: https://stackoverflow.com/questions/36790911/reexport-class-in-typescript

@tbouffard tbouffard merged commit 69224ee into master Feb 1, 2021
@tbouffard tbouffard deleted the 593-minimum_public_API branch February 1, 2021 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[INFRA] Define minimum public API
3 participants