Skip to content

Commit

Permalink
corrected the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
heycatch committed Jun 17, 2024
1 parent d34d2ba commit 20612b3
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 16 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,5 @@ http://localhost:1337/pkg/github.com/heycatch/goshikimori
# Текущие задачи и проблемы в коде можно посмотреть в терминале с помощью команды.
git grep TODO
git grep FIXME
git grep NOTES
```
1 change: 1 addition & 0 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,5 @@ http://localhost:1337/pkg/github.com/heycatch/goshikimori
# Current tasks and problems in the code can be viewed in the terminal using the command.
git grep TODO
git grep FIXME
git grep NOTES
```
1 change: 1 addition & 0 deletions cmd/main.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// It's a testing place, there's nothing interesting here.
package main

import (
Expand Down
4 changes: 2 additions & 2 deletions concat/concat.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,9 @@ func DataCopy(max_len int, slice []string) []byte {

// Auxiliary function to get the correct list of genres.
//
// Name(!) must be capitalized.
// name:
//
// name: GENERATE_GENRES_ANIME or GENERATE_GENRES_MANGA;
// > GENERATE_GENRES_ANIME, GENERATE_GENRES_MANGA;
//
// genres: []api.Genres;
func GenerateGenres(name string, genres []api.Genres) map[int]string {
Expand Down
1 change: 1 addition & 0 deletions configuration.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ func (o *Options) OptionsMessages() string {

if o.Page >= 1 && o.Page <= 100000 { v.Add("page", strconv.Itoa(o.Page)) }
if o.Limit >= 1 && o.Limit <= 100 { v.Add("limit", strconv.Itoa(o.Limit)) }
// The type is required.
if o.Type == "" { v.Add("type", MESSAGE_TYPE_NEWS) } else { v.Add("type", o.Type) }

return v.Encode()
Expand Down
17 changes: 3 additions & 14 deletions goshikimori.go
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ func (f *FastId) SearchUserClubs() ([]api.Clubs, error) {
// - Page: 100000 maximum;
// - Limit: 5000 maximum;
// - Censored: true, false;
//
// - Status:
//
// > MY_LIST_PLANNED, MY_LIST_WATCHING, MY_LIST_REWATCHING,
Expand Down Expand Up @@ -340,6 +341,7 @@ func (f *FastId) SearchUserFavourites() (api.UserFavourites, error) {
// - Page: 100000 maximum;
// - Limit: 100 maximum;
// - Target_id: id anime/manga/ranobe;
//
// - Target_type:
//
// > TARGET_TYPE_ANIME, TARGET_TYPE_MANGA;
Expand Down Expand Up @@ -501,10 +503,6 @@ func (f *FastId) SearchAnime() (api.Anime, error) {

// Name: anime name.
//
// Exclamation mark(!) indicates ignore.
//
// If you use the 'order' parameter, you don't need to enter the name of the anime.
//
// 'Options' settings:
// - Page: 100000 maximum;
// - Limit: 50 maximum;
Expand Down Expand Up @@ -657,10 +655,6 @@ func (f *FastId) SearchManga() (api.Manga, error) {

// Name: manga name.
//
// Exclamation mark(!) indicates ignore.
//
// If you use the 'order' parameter, you don't need to enter the name of the manga.
//
// 'Options' settings:
// - Page: 100000 maximum;
// - Limit: 50 maximum;
Expand Down Expand Up @@ -798,10 +792,6 @@ func (f *FastId) SearchRanobe() (api.Manga, error) {

// Name: ranobe name.
//
// Exclamation mark(!) indicates ignore.
//
// If you use the 'order' parameter, you don't need to enter the name of the ranobe.
//
// 'Options' settings:
// - Page: 100000 maximum;
// - Limit: 50 maximum;
Expand Down Expand Up @@ -3896,6 +3886,7 @@ func (f *FastId) SearchTopicsRanobe(r Result) ([]api.Topics, error) {
// 'Options' settings:
// - Page: 100000 maximum;
// - Limit: 30 maximum;
//
// - Forum:
//
// > TOPIC_FORUM_ALL, TOPIC_FORUM_COSPLAY, TOPIC_FORUM_ANIMANGA, TOPIC_FORUM_SITE,
Expand All @@ -3919,8 +3910,6 @@ func (f *FastId) SearchTopicsRanobe(r Result) ([]api.Topics, error) {
// More information can be found in the [example].
//
// [example]: https://github.com/heycatch/goshikimori/blob/master/examples/topics
//
// TODO: Add implementation of creating/updating/deleting a topic. This is not needed at this stage.
func (c *Configuration) SearchTopics(r Result) ([]api.Topics, int, error) {
var t []api.Topics
var client = &http.Client{}
Expand Down

0 comments on commit 20612b3

Please sign in to comment.