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

Document stability for olx properties #2589

Merged
merged 2 commits into from Aug 22, 2014
Merged

Document stability for olx properties #2589

merged 2 commits into from Aug 22, 2014

Conversation

tschaub
Copy link
Member

@tschaub tschaub commented Aug 22, 2014

The stability level will be used to determine what can change between minor releases.

This adds a ton more "experimental" labels to the doc. The next step is to mark more olx properties as stable (see #2578).

docs

And mark all olx properties with @api.  The stability level will be used to determine what can change between minor releases.
@tschaub tschaub added this to the v3.0.0 milestone Aug 22, 2014
@elemoine
Copy link
Member

Thanks! Please merge.

@elemoine
Copy link
Member

I want to start marking options as stable, so I'm going to merge this PR myself. I hope that's ok to everyone.

elemoine pushed a commit that referenced this pull request Aug 22, 2014
Document stability for olx properties
@elemoine elemoine merged commit 807ddcc into openlayers:master Aug 22, 2014
@elemoine
Copy link
Member

So, as I understand it we need to have @api annotation for the @tydedef's in olx.js. But it makes no difference whether stable or experimental is used for the @typedef. @api just says "I want this type to show up in the documentation. The stability level is indicated for each option, and there's no stability level for the options object itself. I hope my understanding is correct.

@tschaub tschaub deleted the olx-property-stability branch August 22, 2014 13:25
@tschaub
Copy link
Member Author

tschaub commented Aug 22, 2014

@elemoine that's correct. I couldn't think of a good meaning for the stability level for the @typedef - since we want the ability to mark each property individually. I'll write up a doc for this after a couple more doc changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants