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

Reassess partitioned table references #280

Closed
margaretkennedy opened this issue Jul 30, 2024 · 2 comments
Closed

Reassess partitioned table references #280

margaretkennedy opened this issue Jul 30, 2024 · 2 comments
Assignees
Labels

Comments

@margaretkennedy
Copy link
Collaborator

Here is another example of our inconsistent treatment of classes. Many of the methods in this section are methods on PartitionedTable. Having them separate is consistent with what we do with Table but inconsistent with whatever we recently merged. Having said that, this section is unusually inconsistent in that some articles cram multiple methods together. If nothing else, this is a case that needs to be looked at carefully when figuring out what to do with classes.

@jjbrosnan jjbrosnan self-assigned this Aug 9, 2024
@jjbrosnan
Copy link

jjbrosnan commented Aug 9, 2024

In looking at the sidebar for the partitioned table reference section, I don't see any glaring issues.

The biggest "issue" I have is that partition_by lives there, when that's a constructor method and not a method on a partitioned table itself. I also don't know where else we'd put that, so...

I think we need to assess reference structure as a whole rather than just partitioned tables. Things like:

  • What's the standard for documenting classes?
  • Should the partitioned table folder live at the same level as the table operations folder?

In my opinion, we should use the "landing pages" as the class reference page

At that point, the only table-related classes that should get a page are tables themselves and the resultant type of a table operation.
Other than that, support classes should also be given a page like IcebergCatalogAdapter, OperationControl, etc.

@jjbrosnan jjbrosnan added this to the Backlog Community milestone Aug 9, 2024
@jjbrosnan
Copy link

Moving this into backlog until we have agreement on how to proceed so we can assess how long it will take.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants