starred/librespot

Fork 0

mirror of https://github.com/librespot-org/librespot.git synced 2026-04-27 08:15:50 +03:00

[GH-ISSUE #490] Documentation. #307

New issue

Closed

opened 2026-02-27 19:29:56 +03:00 by kerem · 8 comments

kerem commented

2026-02-27 19:29:56 +03:00

Owner

Originally created by @ghost on GitHub (Jun 12, 2020).
Original GitHub issue: https://github.com/librespot-org/librespot/issues/490

Is there documentation for the package? E.G. Functions, methods etc? so we can use in our own project?
something like the example folder

Originally created by @ghost on GitHub (Jun 12, 2020). Original GitHub issue: https://github.com/librespot-org/librespot/issues/490 Is there documentation for the package? E.G. Functions, methods etc? so we can use in our own project? something like the example folder

kerem

2026-02-27 19:29:56 +03:00

closed this issue
added the
enhancement
label

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ashthespy commented on GitHub (Jun 12, 2020):

Most of the documentation in the wiki and docs folder are focused more on the protocol, and building and using librespot as a stand-alone player, and not a library.
Other documentation is spread around in issues and PRs and not really compiled. Our resources are limited, thus PRs are always welcome :-)

@ashthespy commented on GitHub (Jun 12, 2020): Most of the documentation in the wiki and docs folder are focused more on the protocol, and building and using librespot as a stand-alone player, and not a library. Other documentation is spread around in issues and PRs and not really compiled. Our resources are limited, thus PRs are always welcome :-)

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ghost commented on GitHub (Jun 13, 2020):

Interesting. Thanks for the reply. I'll try finding projects that use this and use them as examples to learn from them.

@ghost commented on GitHub (Jun 13, 2020): Interesting. Thanks for the reply. I'll try finding projects that use this and use them as examples to learn from them.

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ghost commented on GitHub (Jun 14, 2020):

@ashthespy can we have an separate gh-pagees branch for auto generated docs from cargo?
better than nothing. If yes LMK i'll open a PR

@ghost commented on GitHub (Jun 14, 2020): @ashthespy can we have an separate gh-pagees branch for auto generated docs from cargo? better than nothing. If yes LMK i'll open a PR

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ghost commented on GitHub (Jun 16, 2020):

@ashthespy bump

@ghost commented on GitHub (Jun 16, 2020): @ashthespy bump

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ashthespy commented on GitHub (Jun 16, 2020):

I'm not sure if I follow - we haven't written any additional docs currently.

The default stuff is automatically pushed to https://docs.rs/librespot/

@ashthespy commented on GitHub (Jun 16, 2020): I'm not sure if I follow - we haven't written any additional docs currently. The default stuff is automatically pushed to https://docs.rs/librespot/

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ghost commented on GitHub (Jun 17, 2020):

@ashthespy the default stuff doesnt seem to be working
https://docs.rs/librespot-core/0.1.1/librespot_core/index.html (this is the link it redirects you to when you click on any one of the options on https://docs.rs/librespot/0.1.1/librespot/ )

@ghost commented on GitHub (Jun 17, 2020): @ashthespy the default stuff doesnt seem to be working https://docs.rs/librespot-core/0.1.1/librespot_core/index.html (this is the link it redirects you to when you click on any one of the options on https://docs.rs/librespot/0.1.1/librespot/ )

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ashthespy commented on GitHub (Jun 17, 2020):

It would seem when the v0.1.1 was published, the various workspace modules docs weren't built/uploaded. You could use v0.1.0 docs instead, there shouldn't be too many API changes b/w the two..

FWIW, the docs at this stage aren't super helpful as all it does is expose the type information and function signatures. It's probably faster to use rust-analyser with the editor of your choice to give you the same hints..

@ashthespy commented on GitHub (Jun 17, 2020): It would seem when the [v0.1.1](https://github.com/librespot-org/librespot/releases/tag/v0.1.1) was published, the various workspace modules docs weren't built/uploaded. You could use [v0.1.0](https://docs.rs/librespot-core/0.1.0/librespot_core/index.html) docs instead, there shouldn't be too many API changes b/w the two.. FWIW, the docs at this stage aren't super helpful as all it does is expose the type information and function signatures. It's probably faster to use [rust-analyser](https://github.com/rust-analyzer/rust-analyzer) with the editor of your choice to give you the same hints..

kerem commented

2026-02-27 19:29:57 +03:00

Author

Owner

@ghost commented on GitHub (Jun 17, 2020):

I already have rust analyzer installed. Thanks for the reply. I am gonna close this issue.

@ghost commented on GitHub (Jun 17, 2020): I already have rust analyzer installed. Thanks for the reply. I am gonna close this issue.

kerem referenced this issue

2026-02-27 20:00:17 +03:00

[PR #307] [MERGED] Use serde 1.0 #873

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/librespot#307

No description provided.

Rows
Columns