Add page for formatting customization #8868
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
poorna2152
force-pushed
the
customizing_formatting
branch
from
fd1700c
to
199432a
Compare
poorna2152
force-pushed
the
customizing_formatting
branch
from
199432a
to
fd1700c
Compare
poorna2152
force-pushed
the
customizing_formatting
branch
from
fd1700c
to
7b95dcc
Compare
anupama-pathirage
requested changes
Apr 5, 2024
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
| { | ||
| source: `/${redirectBase}learn/customizing-formatting`, | ||
| destination: `/${redirectBase}learn/development-tutorials/source-code-dependencies/customizing-formatting`, | ||
| }, |
There was a problem hiding this comment.
Will this add a new left nav entry as well?
There was a problem hiding this comment.
Yes, decided to have a separate left nav entry under source code and dependencies
| #### classBraceStyle: | ||
|
|
||
| * Placement of the opening brace of the class definition. | ||
| * Values: NewLine, EndOfLine |
There was a problem hiding this comment.
Shouldn't we use backticks for NewLine, EndOfLine etc? @MaryamZi
There was a problem hiding this comment.
Yeah, since these are fixed values, we should.
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
|
@poorna2152 Please update https://github.com/ballerina-platform/ballerina-dev-website/blob/master/components/learn/boxes/Boxes.js, to list the new page in the Learn landing page. |
MaryamZi
reviewed
Apr 8, 2024
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
Comment on lines
2
to
6
| title: Customization of formatting | ||
| description: The section on providing custom configurations to the formatter. | ||
| keywords: ballerina, programming language, formatting, custom configurations | ||
| permalink: /learn/customizing-formatting/ | ||
| active: customizing-formatting |
There was a problem hiding this comment.
Can you update these also to be consistent with the rest of these pages, please?
There was a problem hiding this comment.
The layout section is missing here as per @sm1990, this is no longer required
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
|
|
||
| If the `configPath` argument is not provided in the `Ballerina.toml` or the `Format.toml` file does not exist in the project root, default formatting options will be applied. | ||
|
|
||
| If the format `configPath` is an HTTP/HTTPS URL, a cache of the configuration file will be maintained inside the `target` directory. If the remote configuration file is modified, then make sure to delete the cached `Format.toml` file inside the `target/format/` directory. |
There was a problem hiding this comment.
Suggested change
| If the format `configPath` is an HTTP/HTTPS URL, a cache of the configuration file will be maintained inside the `target` directory. If the remote configuration file is modified, then make sure to delete the cached `Format.toml` file inside the `target/format/` directory. | |
| If the format `configPath` value is an HTTP/HTTPS URL, the configuration file will be cached in the `target` directory. If the remote configuration file is modified, then make sure to delete the cached `Format.toml` file inside the `target/format/` directory. |
Did we discuss this user experience anywhere?
There was a problem hiding this comment.
We did have a discussion on this in the earlier stages of the design and decided that it is a responsibility of the user to remove the cached file if it is updated
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customizing-formatting.md
Outdated
Show resolved
Hide resolved
nipunayf
reviewed
Apr 15, 2024
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
MaryamZi
reviewed
Apr 23, 2024
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Outdated
Show resolved
Hide resolved
swan-lake/development-tutorials/source-code-dependencies/customize-formatting.md
Show resolved
Hide resolved
MaryamZi
approved these changes
Apr 29, 2024
anupama-pathirage
approved these changes
Apr 29, 2024
anupama-pathirage
merged commit ef7f50a
into
ballerina-platform:release-2201.9.0
1 check passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Add documentation page for formatting customization.
Documentation for ballerina-platform/ballerina-lang#41280
Checklist
Page addition
permalinkto pages.Page removal
redirect_fromon the alternative page.redirections.jsfile.Page rename
redirect_from.redirect_to:(if applicable).Page restrcuture
permalinkto pages.redirect_from.redirect_to:(if applicable).