Function parse_changelog::parse
source · pub fn parse(text: &str) -> Result<Changelog<'_>, Error>
Expand description
Parses release notes from the given text
.
This function uses the default version and prefix format. If you want to use
another format, consider using the Parser
type instead.
See crate level documentation for changelog and version format supported by default.
§Errors
Returns an error if any of the following:
- There are multiple release notes for one version.
- No release was found. This usually means that the changelog isn’t written in the supported format.