search

flarum / docs

Flarum documentation.
https://docs.flarum.org
MIT License
68 stars 131 forks source link

Rename getSender with getFromUser #368

Closed clarkwinkelmann closed 3 years ago

clarkwinkelmann commented 3 years ago

I noticed the documentation isn't up to date with the interface. getSender was renamed to getFromUser 3 years ago.

There are some other things I noticed...

I ordered the description in the order they come up with in the interface, but the order in the example isn't the same. But since the example is copy-pasted as-it from the source it's also the wrong order in the source. Not sure if I should change the order here to match with the interface to make it easier to read? But then should we also update the source code?

I also noticed the javascript example have updated imports, but the actual files don't have it. For instance I wanted to copy the new version of https://github.com/flarum/subscriptions/blob/master/js/src/forum/components/NewPostNotification.js but it doesn't actually have the forum and common namespace in the source, but already has it here... Not sure what our plan is with those.