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

Improve documentation for methods and their return types #270

Merged
merged 5 commits into from
Feb 2, 2025

Conversation

tiennou
Copy link
Contributor

@tiennou tiennou commented Feb 2, 2025

Brief Description

This copies over the return into from the official docs to have their meaning directly into the docs. Should be purely comment changes (except a few long lines prettier decided to reformat).

Checklists

  • Test passed
  • Coding style (indentation, etc)
  • Edits have been made to src/ files not index.d.ts
  • Run npm run compile to update index.d.ts

@tiennou tiennou mentioned this pull request Feb 2, 2025
4 tasks
@tiennou tiennou marked this pull request as draft February 2, 2025 13:24
@tiennou tiennou force-pushed the fix/return-type-info branch from cc8f5a2 to 2bc70c9 Compare February 2, 2025 13:30
@tiennou
Copy link
Contributor Author

tiennou commented Feb 2, 2025

Fixed the missing ERR_NOT_OWNER on RoomPosition.createConstructionSite() and the accidental deletion of PowerCreep.transfer 😅.

@tiennou tiennou marked this pull request as ready for review February 2, 2025 13:31
@DiamondMofeng DiamondMofeng changed the title Copy over all the return type info Improve documentation for methods and their return types Feb 2, 2025
@DiamondMofeng DiamondMofeng merged commit cb2e5e8 into screepers:master Feb 2, 2025
3 checks passed
@tiennou
Copy link
Contributor Author

tiennou commented Feb 2, 2025

Thanks for the fixups! 🎉

@tiennou tiennou deleted the fix/return-type-info branch February 2, 2025 17:26
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.

2 participants