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

Enhance Documentation #467

Merged
merged 4 commits into from
Apr 22, 2024
Merged

Enhance Documentation #467

merged 4 commits into from
Apr 22, 2024

Conversation

Permanently
Copy link
Contributor

Just to avoid #463 occurring again, here's a change to README.md to reflect the latest version's usage changes.

@OiYouYeahYou
Copy link
Collaborator

My preference would be to recommend adding the plugin config to the .prettierrc, rather than adding it to every command

@Permanently
Copy link
Contributor Author

My preference would be to recommend adding the plugin config to the .prettierrc, rather than adding it to every command

This was more for just the README.md for people's reference, but if it's applicable then might as well - do you mind referencing where? (can't seem to find anywhere I can add it to, and I'm at work)

@OiYouYeahYou
Copy link
Collaborator

Same place that documents the CLI option: https://prettier.io/docs/en/plugins#using-plugins

{
  "plugins": ["@prettier/plugin-pug"]
}

@Permanently Permanently changed the title Updating for v3 usage Updating docs for v3 usage Sep 12, 2023
@Permanently
Copy link
Contributor Author

You did make me remember another file for editing, so caught that whilst it was in my head. Thanks for unintentionally reminding me.

Some people can just add it to the file, but for a CLI lover (like myself) I'd rather stick to having it in-line. You're right though, the other methods should also be covered. This PR was originally gonna cover just the method that's documented, but I'll have a look later and add that in if time's on my side. (if @Shinigami92 or anyone else doesn't do it before me)

@Shinigami92 Shinigami92 added the type: documentation Improvements or additions to documentation label Sep 12, 2023
@Shinigami92
Copy link
Member

You did make me remember another file for editing, so caught that whilst it was in my head. Thanks for unintentionally reminding me.

So is this ready to merge? Or do you need to do something else and right now you cant because e.g. you are out of home, touching grass?

Shinigami92
Shinigami92 previously approved these changes Sep 12, 2023
@Permanently
Copy link
Contributor Author

do you need to do something else and right now you cant because e.g. you are out of home, touching grass?

You won't believe this fella. Grass is real. I thought it was a myth.

Yep, still a draft - lost the button to change the PR state back to draft. If you give me a few hours, I'll make the necessary commits to address the various other methods.

@Shinigami92 Shinigami92 marked this pull request as draft September 12, 2023 16:09
@Shinigami92
Copy link
Member

do you need to do something else and right now you cant because e.g. you are out of home, touching grass?

You won't believe this fella. Grass is real. I thought it was a myth.

🤯 💚

Yep, still a draft - lost the button to change the PR state back to draft. If you give me a few hours, I'll make the necessary commits to address the various other methods.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -85,22 +122,4 @@ Pug code with automatic formatting:

## Type support in configuration file
Copy link
Member

Choose a reason for hiding this comment

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

Does this content section do not have content anymore?

@Shinigami92
Copy link
Member

You can also please run prettier before doing a commit, that does some stuff for you

@Permanently Permanently changed the title Updating docs for v3 usage Updating docs for v3 usage + covering alternate methods Sep 12, 2023
@Permanently
Copy link
Contributor Author

You can also please run prettier before doing a commit, that does some stuff for you

Apologies, didn't cross my mind - my environment's changed so I'm still reinstalling packages 😓

Does this content section do not have content anymore?

Re: header, amended that on the latest commit, looks like I won't be doing anything that requires thought after work in the future as I'm clearly pooped hahaha

@Shinigami92 Shinigami92 marked this pull request as draft September 12, 2023 19:44
@Shinigami92 Shinigami92 marked this pull request as ready for review April 22, 2024 08:49
@Shinigami92 Shinigami92 changed the title Updating docs for v3 usage + covering alternate methods Enhance Documentation Apr 22, 2024
@Shinigami92 Shinigami92 merged commit 4b13e6d into prettier:main Apr 22, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants