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.

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

Add speed_note_count to docs #10976

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

HonKLam
Copy link
Contributor

@HonKLam HonKLam commented Feb 6, 2024

Resolves #10345

API call for BeatmapDifficultyAttributes looks like this (in osu):

image

So I added the missing speed_note_count to docs and it looks like this now:

image

I also checked the other gamemodes and found some things off:

Taiko

API

image

Docs

image

(peak_difficulty vs approach_rate)

Mania

API

image

Docs

image

(score_multiplier just missing in general?)


Is this intended? Otherwise I can offer to fix it in the docs.

@notbakaneko
Copy link
Collaborator

BeatmapDifficultyAttributes depends on the output of osu-beatmap-difficulty-lookup-cache which may change and is better documented else where, in my opinion.

@HonKLam
Copy link
Contributor Author

HonKLam commented Feb 8, 2024

and is better documented else where, in my opinion

If BeatmapDifficultyAttributes should not be documented in osu docs, but can be requested via API, where should it be documented then?

Could also put in a note in docs that states that BeatmapDifficultyAttributes is subject to change, but that applies to every endpoint or output, doesn't it?

@nanaya
Copy link
Collaborator

nanaya commented Feb 9, 2024

If BeatmapDifficultyAttributes should not be documented in osu docs, but can be requested via API, where should it be documented then?

the linked project which the endpoint proxies to

Could also put in a note in docs that states that BeatmapDifficultyAttributes is subject to change, but that applies to every endpoint or output, doesn't it?

the code and documentation for other endpoints are in the same repository whereas this one the code is in another castle

@HonKLam
Copy link
Contributor Author

HonKLam commented Feb 9, 2024

the code and documentation for other endpoints are in the same repository whereas this one the code is in another castle

I will leave it to the other castle then to update the docs if it's more fitting there. If it happens, maybe put a note in osu-web docs that refers to it?

Feel free to close PR or keep it open as a reminder

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

Successfully merging this pull request may close these issues.

Speed note count not documented
3 participants