Skip to content

Commit 56c3da8

Browse files
committed
Fix Markdown issue as reported by Megalint
1 parent 8930fc0 commit 56c3da8

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

CHANGELOG.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# ConfigMe Changelog
22

33
## ConfigMe 1.x
4-
#### 1.4.1 (2023-08-28)
4+
### 1.4.1 (2023-08-28)
55
- `@ExportName` can be added on bean fields (previously, it was only possible on accessor methods) ([#366](https://github.com/AuthMe/ConfigMe/issues/366))
66
- Bug fix: unique comment is repeated if it's in a MapProperty, ListProperty or similar ([#362](https://github.com/AuthMe/ConfigMe/issues/362))
77
- Bug fix: Property at root path `""` could be defined with other properties ([#363](https://github.com/AuthMe/ConfigMe/issues/363))
88
- Add getter for property type in TypeBasedProperty ([#333](https://github.com/AuthMe/ConfigMe/issues/333))
99

1010
:blue_book: [All changes in 1.4.1](https://github.com/AuthMe/ConfigMe/milestone/16?closed=1)
1111

12-
#### 1.4.0 (2023-08-12)
12+
### 1.4.0 (2023-08-12)
1313
- Annotated all methods with `@NotNull` and `@Nullable` for better type inference in Kotlin ([#235](https://github.com/AuthMe/ConfigMe/pull/235), [#318](https://github.com/AuthMe/ConfigMe/issues/318))
1414
- Support `@Comment` on fields of bean properties ([#18](https://github.com/AuthMe/ConfigMe/issues/18))
1515
- Please read about [breaking changes](https://github.com/AuthMe/ConfigMe/issues/18#issuecomment-1663973493) if you extend `YamlFileResource` or other internals.
@@ -22,13 +22,13 @@
2222

2323
:blue_book: [All changes in 1.4.0](https://github.com/AuthMe/ConfigMe/milestone/13?closed=1)
2424

25-
#### 1.3.1 (2023-06-20)
25+
### 1.3.1 (2023-06-20)
2626
- Update SnakeYAML dependency for security reasons ([#310](https://github.com/AuthMe/ConfigMe/issues/310))
27-
- Introduce ShortProperty, LongProperty and FloatProperty for convenience ([#260](https://github.com/AuthMe/ConfigMe/issues/268))
27+
- Introduce ShortProperty, LongProperty and FloatProperty for convenience ([#260](https://github.com/AuthMe/ConfigMe/issues/268))
2828

2929
:blue_book: [All changes in 1.3.1](https://github.com/AuthMe/ConfigMe/milestone/14?closed=1)
3030

31-
#### 1.3.0 (2021-10-17)
31+
### 1.3.0 (2021-10-17)
3232
- Introduce option to NOT split paths that contain dots in the YAML file ([#214](https://github.com/AuthMe/ConfigMe/issues/214))
3333
- Add support for BigInteger and BigDecimal in bean properties ([#182](https://github.com/AuthMe/ConfigMe/issues/182))
3434
- Support map properties at root path-level properly when they are empty ([#191](https://github.com/AuthMe/ConfigMe/issues/191))
@@ -37,7 +37,7 @@
3737

3838
:blue_book: [All changes in 1.3.0](https://github.com/AuthMe/ConfigMe/milestone/11?closed=1)
3939

40-
#### 1.2.0 (2020-09-04)
40+
### 1.2.0 (2020-09-04)
4141
- Better ability to trigger a resave for partially valid values ([#19](https://github.com/AuthMe/ConfigMe/issues/19))
4242
- See [comment about breaking changes](https://github.com/AuthMe/ConfigMe/issues/19#issuecomment-569066960)
4343
- Indentation size and number of empty lines are now configurable in YamlFileResourceOptions ([#127](https://github.com/AuthMe/ConfigMe/issues/127))
@@ -48,7 +48,7 @@
4848

4949
:blue_book: [All changes in 1.2.0](https://github.com/AuthMe/ConfigMe/milestone/9?closed=1)
5050

51-
#### 1.1.0 (2019-02-27)
51+
### 1.1.0 (2019-02-27)
5252
- New property structure allowing to easily define maps and lists, see PropertyInitializer
5353
- Support paths written together (e.g. "path.foo") in YML files
5454
- Fix bug in which paths with special sequences (like numbers) cannot be read
@@ -58,15 +58,15 @@
5858

5959
:blue_book: [All changes in 1.1.0](https://github.com/AuthMe/ConfigMe/milestone/6?closed=1)
6060

61-
#### 1.0.1 (2018-09-08)
61+
### 1.0.1 (2018-09-08)
6262
- Support all Collection types for export values (not only lists)
6363
- Fixes built-in lowercase String Set property creating output which cannot be read again
6464
- Add getter on ConfigurationData to get all comments
6565
- If not defined, SettingsManagerBuilder creates a manager that uses no migration service (instead of the default one)
6666

6767
:blue_book: [All changes in 1.0.1](https://github.com/AuthMe/ConfigMe/milestone/10?closed=1)
6868

69-
#### 1.0 (2018-09-08)
69+
### 1.0 (2018-09-08)
7070
- Large refactoring: see [Migrating from 0.x to 1.x](https://github.com/AuthMe/ConfigMe/wiki/Migrating-from-0.x-to-1.x) for migration guide
7171
- Improve codebase, especially the export of values and the bean mapper ([#56](https://github.com/AuthMe/ConfigMe/issues/56))
7272
- Fix serialization of nested beans ([#55](https://github.com/AuthMe/ConfigMe/issues/55))
@@ -80,12 +80,12 @@
8080
:blue_book: [All changes in 1.0](https://github.com/AuthMe/ConfigMe/milestone/8?closed=1)
8181

8282
## ConfigMe 0.x
83-
#### 0.4.1 (2018-01-14)
83+
### 0.4.1 (2018-01-14)
8484
- Fix `Optional` fields not being able to be saved in bean properties ([#51](https://github.com/AuthMe/ConfigMe/issues/51))
8585

8686
:blue_book: [All changes in 0.4.1](https://github.com/AuthMe/ConfigMe/milestone/7?closed=1)
8787

88-
#### 0.4 (2017-02-19)
88+
### 0.4 (2017-02-19)
8989
- Add support for `Optional`
9090
- New optional property type `OptionalProperty`
9191
- Support `Optional<?>` fields in beans
@@ -98,7 +98,7 @@
9898

9999
:blue_book: [All changes in 0.4](https://github.com/AuthMe/ConfigMe/milestone/4?closed=1)
100100

101-
#### 0.3 (2016-12-23)
101+
### 0.3 (2016-12-23)
102102
- Now available from Maven Central!
103103
- The project package is now `ch.jalu.configme`
104104
- Enhance handling of bean properties
@@ -116,7 +116,7 @@
116116

117117
:blue_book: [All changes in 0.3](https://github.com/AuthMe/ConfigMe/milestone/3?closed=1)
118118

119-
#### 0.2.1 (2016-10-22)
119+
### 0.2.1 (2016-10-22)
120120
Bugfix release:
121121
- Fix YAML export of a beans property at root path
122122
- Allow values of bean properties to be set via SettingsManager
@@ -125,14 +125,14 @@ Bugfix release:
125125
:blue_book: [All changes in 0.2.1](https://github.com/AuthMe/ConfigMe/milestone/5?closed=1)
126126

127127

128-
#### 0.2 (2016-10-16)
128+
### 0.2 (2016-10-16)
129129
- Allow mapping of configurations to JavaBeans classes
130130
- Allow to provide comments for sections
131131

132132
:blue_book: [All changes in 0.2](https://github.com/AuthMe/ConfigMe/milestone/2?closed=1)
133133

134134

135-
#### 0.1 (2016-09-04)
135+
### 0.1 (2016-09-04)
136136
Initial release:
137137
- Cleanup of previously internally used configuration management
138138
- Changes to make more generic

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ConfigMe is managed heavily based on GitHub issues, so you're invited to open a
1010
code changes first, either by creating an issue or by writing in the [`#configme` channel](https://discord.com/channels/295623711485198357/1143605240520769547)
1111
of the AuthMe Discord server.
1212

13-
# General conventions
13+
## General conventions
1414

1515
- If you're using IntelliJ, please install the Checkstyle plugin and configure it to use the rules from
1616
`.checkstyle.xml`, located in the project's root directory.
@@ -20,7 +20,7 @@ of the AuthMe Discord server.
2020

2121
No sweat if some points aren't met since they can be addressed in pull requests, and PRs can be squashed.
2222

23-
# Code style
23+
## Code style
2424

2525
Please try to match the current code style. A few pointers:
2626
- Indent with spaces, not tabs
@@ -29,13 +29,13 @@ Please try to match the current code style. A few pointers:
2929
- Use camel-case as defined in the [Google Java style guide](https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
3030
(i.e. use names like `setHttpLink`, not `setHTTPLink`)
3131

32-
## Javadoc
32+
### Javadoc
3333

3434
- Use the third-person form of verbs and not the imperative: "Gets all properties" and not "Get all properties".
3535
- Avoid `@link` to common JDK types like `Map` or `String`. These types are visible from the method signature—manually
3636
linking them adds no value.
37-
- Try to provide context rather than just un-camel-case-ing the thing you're describing
38-
(e.g. "Gets the result" on a method "getResult" does not provide any additional information).
37+
- Try to provide context rather than just un-camel-case-ing the thing you're describing
38+
(e.g. "Gets the result" on a method "getResult" does not provide any additional information).
3939
- Do not close `<p>` tags in Javadoc text. This is in line with the JDK and Oracle's [recommendations](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format).
4040
- Do not align parameter descriptions (in the form of `@param name     the name` because of
4141
another longer param name).

src/test/java/ch/jalu/configme/demo/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## ConfigMe demo
1+
# ConfigMe demo
22

33
This folder contains a small demonstration showing how ConfigMe can be used.
44
You can find the config.yml file [here](https://github.com/AuthMe/ConfigMe/blob/master/src/test/resources/demo/config.yml).
@@ -13,6 +13,6 @@ are present in the config.yml file; if not, it will save the file, which trigger
1313
properties to be saved with their default value.
1414

1515
You can also add a new Property field to the `TitleConfig` and see how you can immediately use it
16-
in your application, even without worrying about `null` values. Users with an old config.yml file
16+
in your application, even without worrying about `null` values. Users with an old config.yml file
1717
will automatically be migrated and will find the new property with its default value next time they
1818
start the application.

src/test/java/ch/jalu/configme/demo/beans/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## Demo with beans
1+
# Demo with beans
22

33
This is a demo showing how you can use a custom bean with ConfigMe. The classes `Location`,
44
`User`, and `UserBase` are beans. ConfigMe can scan these classes to determine the properties
55
they have and will then use the config.yml file to create new objects with the data inside
6-
config.yml. `BeanPropertiesDemo` creates a settings manager and uses it to get the
6+
config.yml. `BeanPropertiesDemo` creates a settings manager and uses it to get the
77
`DemoSettings.USER_BASE` setting.
88

99
You can find the config YAML file [here](https://github.com/AuthMe/ConfigMe/blob/master/src/test/resources/demo/bean_demo_config.yml).

0 commit comments

Comments
 (0)