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

DOC Document new FormSchemaController #628

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

GuySartorelli
Copy link
Member

To view an example of a controller that follows these standards see [`LinkFieldController`](https://github.com/silverstripe/silverstripe-linkfield/blob/4/src/Controllers/LinkFieldController.php).
To view an example of a controller that follows these standards see [`LinkFieldController`](api:SilverStripe\LinkField\Controllers\LinkFieldController).
Copy link
Member Author

Choose a reason for hiding this comment

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

Unrelated change - link should be an API link

Comment on lines -783 to +795
> [!INFO] If you need to use GraphQL in your project for public-facing frontend schemas, you can still install and use the [`silverstripe/graphql`](https://github.com/silverstripe/silverstripe-graphql) module.
> [!NOTE]
> If you need to use GraphQL in your project for public-facing frontend schemas, you can still install and use the [`silverstripe/graphql`](https://github.com/silverstripe/silverstripe-graphql) module.
Copy link
Member Author

Choose a reason for hiding this comment

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

Unrelated - wasn't rendering correctly.

- [`CMSExternalLinksController`](api:SilverStripe\ExternalLinks\Controllers\CMSExternalLinksController) - used to be a direct subclass of [`Controller`](api:SilverStripe\Control\Controller).
As a result of these changes, the following classes have had their class hierarchy updated:

|class|old superclass|new superclass|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
|class|old superclass|new superclass|
|Class|Old super class|New super class|

Copy link
Member

Choose a reason for hiding this comment

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

Would parent class be better than super class?

Copy link
Member Author

@GuySartorelli GuySartorelli Nov 14, 2024

Choose a reason for hiding this comment

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

The capitalisation isn't consistent with other tables in this page. Can you please look at the page in its rendered form (so you can see in context) and decide if you want the headers for all tables capitalised or lower-case? If you want them capitalised I'll update all the other tables as well.

Would parent class be better than super class?

They mean the same thing so I don't mind either way - just let me know whether you want that change or not.

We do already use "superclass" multiple times in the changelog, "super class" once, and "parent class" only once, in case that helps you decide.

Copy link
Member

Choose a reason for hiding this comment

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

They should all be capitalized, looks wrong if it's lower case. Leave as super class if it's consistent

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it looks weird capitalized lol but I'll make the change.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@emteknetnz emteknetnz merged commit 784ec42 into silverstripe:6 Nov 19, 2024
3 checks passed
@emteknetnz emteknetnz deleted the pulls/6/formschema branch November 19, 2024 04:45
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