mastodon-dart / mastodon-api

This library provides the easiest and powerful Dart/Flutter library for Mastodon API 🎯
http://pub.dev/packages/mastodon_api
BSD 3-Clause "New" or "Revised" License
64 stars 13 forks source link

Increase visibility to items in lib/src #94

Closed alevinetx closed 1 year ago

alevinetx commented 1 year ago

mastodon_api: ^0.2.2

Example:

Future<MastodonResponse<List<Rule>>> server.v1.instance.lookupRules()

lookupRules() is contained in InstanceV1Service, which doesn't appear in the documentation. Rule doesn't appear in the documentation. IDE cannot find Rule to understand its data type unless I explicitly import package:mastodon_api/src/service/entities/rule.dart

2. Why should this be improved

Beyond improving IDE interaction, this should help improve the generated documentation; there are currently missing items.

3. Any risks?

?

github-actions[bot] commented 1 year ago

Thanks for your contribution! :)

myConsciousness commented 1 year ago

Hi @alevinetx , thanks for your feedback :)

I understand, but it's difficult from a development resource perspective to write a description of all model objects provided in this package in a README or similar document. Also, these model objects have the same structure as the official mastodon entities, and I feel we would be better off reading the official references that are already in place.

The structure of the service in which the endpoints are implemented is also the same as the official mastodon, and mappings exist in the following sections :)

alevinetx commented 1 year ago

Hello!

I'm not suggesting adding manual documentation, but rather adding additional exports in lib/mastodon_api.dart

myConsciousness commented 1 year ago

@alevinetx ,

Oh my bad, I was not aware that these objects are not publicly available!

Would you be interested in a pull request for this Issue? :)

alevinetx commented 1 year ago

Sure, let me see what I can do