Skip to content

CG-10508: Docs explain differences between SourceFile and File types #138

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

Merged
merged 9 commits into from
Jan 28, 2025

Conversation

jemeza-codegen
Copy link
Contributor

Motivation

SourceFile is currently not mentioned in the Building with Codegen Section

Content

Add content explaining the differences between SourceFile and File

  • I have added tests for my changes (N/A)
  • I have updated the documentation or added new documentation as needed
  • I have read and agree to the Contributor License Agreement

Copy link

linear bot commented Jan 28, 2025

CG-10508 Get `File.get_symbol(...)` in docs

  • Missing File.get_class, File.get_symbol, etc.
    • Explain File vs. SourceFile
  • Add these in!
  • Edit the Files and Directories guide

Copy link
Contributor

@jayhack jayhack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jemeza-codegen can we make it more obvious that using raw File is the minority case, and the majority of the time you are iterating over SourceFile?

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


codegen-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@jemeza-codegen jemeza-codegen merged commit 5c32360 into develop Jan 28, 2025
8 of 13 checks passed
@jemeza-codegen jemeza-codegen deleted the file-types-docs branch January 28, 2025 20:11
jayhack pushed a commit that referenced this pull request Feb 9, 2025
…138)

# Motivation
SourceFile is currently not mentioned in the Building with Codegen
Section

# Content
Add content explaining the differences between SourceFile and File

- [x] I have added tests for my changes (N/A)
- [x] I have updated the documentation or added new documentation as
needed
- [x] I have read and agree to the [Contributor License
Agreement](../CLA.md)

---------

Co-authored-by: codegen-bot <[email protected]>
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.

3 participants