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.

Sign up for GitHub

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

Jump to bottom

Increase visibility to items in lib/src #94

Closed
alevinetx opened this issue Dec 27, 2022 · 5 comments · Fixed by #95
Closed

Increase visibility to items in lib/src #94

alevinetx opened this issue Dec 27, 2022 · 5 comments · Fixed by #95
Assignees
@alevinetx @myConsciousness
Labels
enhancement New feature or request

Comments

@alevinetx
Copy link
Contributor

alevinetx commented Dec 27, 2022 •
edited

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?

?
@alevinetx alevinetx added enhancement New feature or request untriaged labels Dec 27, 2022
@github-actions
Copy link

Thanks for your contribution! :)

@myConsciousness
Copy link
Member

myConsciousness commented Dec 27, 2022 •
edited

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
Copy link
Contributor Author

Hello!

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

@myConsciousness
Copy link
Member

@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
Copy link
Contributor Author

Sure, let me see what I can do

@alevinetx alevinetx mentioned this issue Dec 30, 2022
Merged
7 tasks
myConsciousness added a commit that referenced this issue Dec 30, 2022
@myConsciousness
docs: fixed for the issue (#94)
c3832d8 
Co-authored-by: myConsciousness <contact@shinyakato.dev>
bors bot added a commit that referenced this issue Dec 30, 2022
@bors @alevinetx @myConsciousness
Merge #97
ad2984b 
97: fix: fixed for the issue (#94) r=myConsciousness a=myConsciousness

# 1. Description

<!-- Provide a description of what this PR is doing.
If you're modifying existing behavior, describe the existing behavior, how this PR is changing it,
and what motivated the change. If this is a breaking change, specify explicitly which APIs have been
changed. -->

## 1.1. Checklist

<!-- Before you create this PR confirm that it meets all requirements listed below by checking the
relevant checkboxes (`[x]`). This will ensure a smooth and quick review process. -->

- [x] The title of my PR starts with a [Conventional Commit] prefix (`fix:`, `feat:`, `docs:` etc).
- [x] I have read the [Contributor Guide] and followed the process outlined for submitting PRs.
- [x] I have updated/added tests for ALL new/updated/fixed functionality.
- [x] I have updated/added relevant documentation in `docs` and added dartdoc comments with `///`.
- [x] I have updated/added relevant examples in `examples`.

## 1.2. Breaking Change

<!-- Does your PR require users to manually update their apps to accommodate your change?

If the PR is a breaking change this should be indicated with suffix "!"  (for example, `feat!:`, `fix!:`). See [Conventional Commit] for details.
-->

- [ ] Yes, this is a breaking change.
- [x] No, this is _not_ a breaking change.

## 1.3. Related Issues

<!-- Provide a list of issues related to this PR from the [issue database].
Indicate which of these issues are resolved or fixed by this PR, i.e. Fixes #xxxx* !-->

<!-- Links -->

[issue database]: https://github.com/mastodon-dart/mastodon-api/issues
[contributor guide]: https://github.com/mastodon-dart/mastodon-api/blob/main/CONTRIBUTING.md
[style guide]: https://github.com/mastodon-dart/mastodon-api/blob/main/STYLEGUIDE.md
[conventional commit]: https://conventionalcommits.org


Co-authored-by: alevinetx <adam.l.levine@gmail.com>
Co-authored-by: myConsciousness <contact@shinyakato.dev>
@bors bors bot closed this as completed in #95 Dec 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alevinetx alevinetx

@myConsciousness myConsciousness

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat:Added additional exports for IDE and documentation visibility alevinetx/mastodon-api
2 participants
@alevinetx @myConsciousness