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

C#: Add table with equivalent Dictionary methods #6676

Merged
merged 3 commits into from
Jan 28, 2023

Conversation

raulsntos
Copy link
Member

  • Follow up to Sync C# Dictionary with Core godot#71984.
  • Adds a table with the list of C# methods that are equivalent to the methods in Godot's Dictionary to make it easier to users to port from GDScript and find which APIs are available.

@raulsntos raulsntos added enhancement topic:dotnet area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 27, 2023
@paulloz
Copy link
Member

paulloz commented Jan 27, 2023

Would it be useful to add a precision about Godot.Collections.Dictionary implementing IDictionary somewhere (same question about arrays implementing IArray)?

@raulsntos
Copy link
Member Author

I was thinking of extracting some of the content of this page to individual pages, like you did with signals. For example we could have a dedicated page about collections that extract the Array and Dictionary sections, and then we can link to it from this page.

The new dedicated collections page could contain more details about how Godot collections work, I would also mention the cost of marshaling, and some explanation about when to use them over .NET collections.

But all of this can be done in a future PR.

@paulloz
Copy link
Member

paulloz commented Jan 27, 2023

Perfect.

@YuriSizov
Copy link
Contributor

Should the methods and operators in this table, both GDScript and C#, be formatted as inline code with parentheses at the end? for consistency with the rest of the article. Lines that feature text should, of course, be formatted as text when appropriate.

@raulsntos
Copy link
Member Author

It matches the StringExtensions table, the reason is that I can't add links to text formatted as inline code. In this table there are no links but I decided to be consistent with the StringExtensions table.

@YuriSizov YuriSizov merged commit db63931 into godotengine:master Jan 28, 2023
@YuriSizov
Copy link
Contributor

Thanks!

@raulsntos raulsntos deleted the dotnet/dictionary-docs branch January 28, 2023 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:dotnet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants