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

Update shadertype.md #1841

Merged
merged 1 commit into from
Apr 15, 2023
Merged

Update shadertype.md #1841

merged 1 commit into from
Apr 15, 2023

Conversation

thetyl
Copy link
Contributor

@thetyl thetyl commented Mar 24, 2022

What does this PR do?
Update the shadertype documentation to remove auto-generated text and add a description and example.

Thanks for the contribution! Please provide a concise description of the problem this request solves.

How does this PR change Premake's behavior?
Modifies the Premake documentation.

Are there any breaking changes? Will any existing behavior change?
No.

Anything else we should know?
No.

Add any other context about your changes here.

Did you check all the boxes?

  • [CHECK] Focus on a single fix or feature; remove any unrelated formatting or code changes
  • [CHECK ] Add unit tests showing fix or feature works; all tests pass
  • [CHECK ] Mention any related issues (put closes #XXXX in comment to auto-close issue when PR is merged)
  • [CHECK ] Follow our coding conventions
  • [CHECK ] Minimize the number of commits
  • [CHECK ] Align documentation to your changes

You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!

Copy link
Member

@KyrietS KyrietS left a comment

Choose a reason for hiding this comment

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

You could add some more info about this parameter, but I guess It's better than nothing. Thanks.
Note that we have other shaderX pages that are auto-generated. If you are somwehat involved in compiling shaders with Premake then please don't hesitate to improve other pages as well 🙃

website/docs/shadertype.md Outdated Show resolved Hide resolved
@thetyl thetyl requested a review from nickclark2016 March 29, 2022 23:53
@nickclark2016
Copy link
Member

Sorry, one last minor thing and I'll leave you alone. Instead of making a new commit, could you just amend the previous?

git reset HEAD~
git add --all
git commit --amend --no-edit

We try to keep the number of commits to a minimum (this should be applied to all your PRs).

@KyrietS
Copy link
Member

KyrietS commented Nov 28, 2022

@TylerDahl please squash your commits if you want to be listed on git blame (and our website) as an author of this change.

  1. Go to your repo and checkout your branch patch-1: git checkout patch-1
  2. git reset --soft master
  3. git add .
  4. git commit -m "Update shadertype.md"
  5. git push --force

If you don't respond then I'll merge your change using squash method.
Also @nickclark2016 is your change request resolved? Do you approve this commit in it's current state?

Changed shadertype parameter format.
@thetyl
Copy link
Contributor Author

thetyl commented Nov 28, 2022

@KyrietS Just squashed my commits.

@KyrietS
Copy link
Member

KyrietS commented Nov 29, 2022

Let's wait for @nickclark2016's approval

@samsinsane samsinsane merged commit 511b802 into premake:master Apr 15, 2023
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.

4 participants