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

Remove unnecessary randomisation from auth description #639

Merged
merged 1 commit into from
Apr 8, 2023

Conversation

bram-pkg
Copy link
Contributor

Whenever new documentation is generated, it should ideally not change if none of the backing endpoints or configuration has changed. I think this randomisation should not occur while generating the contents of API documentation.

@shalvah
Copy link
Contributor

shalvah commented Mar 28, 2023

This makes a lot of sense. My motivation for randomness is to vary things a bit between users, so not everyone's docs look exactly the same. Maybe I'll just use the documentation title as a seed. 🤔

@bram-pkg
Copy link
Contributor Author

I think it would make sense to have no randomisation and at all, it's good for libraries to be determinate about their output. Nowhere is it implied this is randomised. Ideally the whole auth section would be customisable, but removing the randomisation is the next best thing really.

@shalvah
Copy link
Contributor

shalvah commented Apr 8, 2023

I still favour a bit of variety, but I'll go with this now, especially as there are plans to introduce a translation system in future, which could allow users specify their own message.

@shalvah shalvah merged commit 441e742 into knuckleswtf:master Apr 8, 2023
@bram-pkg
Copy link
Contributor Author

bram-pkg commented Apr 8, 2023

Translations would indeed fix the core issue here, this is a good intermediary step though :)

@shalvah shalvah mentioned this pull request Apr 20, 2023
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.

None yet

2 participants