From 56dcd41c809d400bd3967a25d66b7320b986c2b1 Mon Sep 17 00:00:00 2001
From: Volodymyr Buberenko <v.buberenko@gmail.com>
Date: Fri, 28 Apr 2023 08:53:33 +0300
Subject: [PATCH] docs(package_info_plus): Explain why buildNumber return
 version when no build number defined

---
 docs/package_info_plus/usage.mdx                             | 5 +++++
 .../package_info_plus/lib/package_info_plus.dart             | 2 ++
 2 files changed, 7 insertions(+)

diff --git a/docs/package_info_plus/usage.mdx b/docs/package_info_plus/usage.mdx
index 72d42e455e..95c3ff21f9 100644
--- a/docs/package_info_plus/usage.mdx
+++ b/docs/package_info_plus/usage.mdx
@@ -46,6 +46,11 @@ requires the Xcode build folder to be rebuilt after changes to the version strin
 Clean the Xcode build folder with:
 `XCode Menu -> Product -> (Holding Option Key) Clean build folder`.
 
+#### Plugin returns package version in `buildNumber` when no build number specified in pubspec.yaml
+
+Plugin doesn't modify the output of iOS. In this case `buildNumber` in the plugin is CFBundleVersion in iOS. This property returns version when build number is not specified.buildNumber
+See [CFBundleVersion docs](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion) for more inf.
+
 ### Android (and potentially all platforms)
 
 Calling to `PackageInfo.fromPlatform()` before the `runApp()` call will cause an exception.
diff --git a/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart b/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart
index 5c44c1fff4..7c07f46bba 100644
--- a/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart
+++ b/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart
@@ -60,6 +60,8 @@ class PackageInfo {
   final String version;
 
   /// The build number. `CFBundleVersion` on iOS, `versionCode` on Android.
+  /// Note, on iOS if an app has no buildNumber specified this property will return version
+  /// Docs about CFBundleVersion: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion
   final String buildNumber;
 
   /// The build signature. Empty string on iOS, signing key signature (hex) on Android.