Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

TextBuffer description is missing in README #68

Open
sergei-dyshel opened this issue Nov 5, 2018 · 4 comments
Open

TextBuffer description is missing in README #68

sergei-dyshel opened this issue Nov 5, 2018 · 4 comments

Comments

@sergei-dyshel
Copy link
Contributor

At least some basic description (constructor and other basic methods which can not be deduced from index.js) would be helpful.

@Arcanemagus

This comment has been minimized.

@Arcanemagus

This comment has been minimized.

@Arcanemagus Arcanemagus reopened this Nov 5, 2018
@sergei-dyshel
Copy link
Contributor Author

sergei-dyshel commented Nov 6, 2018

I'm being a little pedantic here: while I totally understand that superstring is part of Atom and it's alright that classes provided by it are documented in Atom API docs, it's also a standalone node package so one may use it without any relation to Atom (actually I do) so one may expect to have some standalone documentation for the module itself.

You already describe Patch and MarkerIndex in the README, why not describe TextBuffer too?

@Arcanemagus
Copy link

it's also a standalone node package so one may use it without any relation to Atom (actually I do) so one may expect to have some standalone documentation for the module itself.

I confused this with something else, sorry!

Again, I confused this issue with something entirely unrelated, sorry!

You already describe Patch and MarkerIndex in the README, why not describe TextBuffer too?

A PR adding this documentation would be wonderful!

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

No branches or pull requests

2 participants