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

EditSession.getMarkers documentation incorrect #4347

Closed
milesfrain opened this issue Jul 25, 2020 · 2 comments
Closed

EditSession.getMarkers documentation incorrect #4347

milesfrain opened this issue Jul 25, 2020 · 2 comments

Comments

@milesfrain
Copy link

#3173 is still an issue. Not sure why that was closed.

The docs are correct in the .js file.

ace/lib/ace/edit_session.js

Lines 664 to 672 in 0a88b88

/**
* Returns an object containing all of the markers, either front or back.
* @param {Boolean} inFront If `true`, indicates you only want front markers; `false` indicates only back markers
*
* @returns {Object}
**/
this.getMarkers = function(inFront) {
return inFront ? this.$frontMarkers : this.$backMarkers;
};

But not in the .html file. It still incorrectly describes "array of IDs" instead of "object of markers".

ace/api/edit_session.html

Lines 1242 to 1245 in 0a88b88

<div id="ellipsis_EditSession.getMarkers" class="ellipsis_description"><p>Returns an array containing the IDs of all the markers, either front or back.</p>
</div>
<div class="description"><p>Returns an array containing the IDs of all the markers, either front or back.</p>

Are these files autogenerated?

@github-actions
Copy link

github-actions bot commented May 9, 2022

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

@milesfrain
Copy link
Author

This is still an issue

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

No branches or pull requests

1 participant