search

CyrilleB79 / charInfo

This addon for NVDA screen reader provides detailed character information when pressing four times the review current character gesture.
GNU General Public License v2.0
1 stars 4 forks source link

Don't include compatibility range in the readme #12

Closed nvdaes closed 9 months ago

nvdaes commented 9 months ago

In the readme of this add-on, we can see the following information:

NVDA compatibility: 2022.3.3 and beyond

This suggest that this add-on is compatible with all versions beyond 2022.3.3, but in fact it's not compatible with NVDA 2024.1beta versions, since the manifest.ini doesn't specify this version. Since in the store we can see the last version of each add-on which is compatible with the running version of NVDA for the selected channel, the easiest option (and my strategy) is omitting the compatibility range in the readme. Another strategy maybe to reflect the compatibility in the documentation for each version, but this maybe burden and maybe confusing if a new breaking compatibility API version is published for NVDA, @CyrilleB79 .

I'm creating this issue, as requested in nvaccess/addon-datastore#2483

CyrilleB79 commented 9 months ago

In the readme of this add-on, we can see the following information:

NVDA compatibility: 2022.3.3 and beyond

This suggest that this add-on is compatible with all versions beyond 2022.3.3, but in fact it's not compatible with NVDA 2024.1beta versions, since the manifest.ini doesn't specify this version.

I agree that the add-on is not compatible with NVDA 2024.1 since I have not updated the manifest, on purpose. Since I have made the choice to release only stable versions of this add-on, and since the documentation that you are quoting is extracted from a stable version, you cannot expect (yet) the add-on to be compatible with NVDA 2024.1 since NVDA 2024.1 is still in beta testing phase.

In the add-on's change log, I have written:

Prepares compatibility with NVDA 2024.1: speech on-demand support.

That means that I prepare the compatibility code, but I do not yet claim to be compatible with NVDA 2024.1 since the API may still change during NVDA beta phase, thought unlikely.

Since in the store we can see the last version of each add-on which is compatible with the running version of NVDA for the selected channel, the easiest option (and my strategy) is omitting the compatibility range in the readme. Another strategy maybe to reflect the compatibility in the documentation for each version, but this maybe burden and maybe confusing if a new breaking compatibility API version is published for NVDA, @CyrilleB79 .

I agree that writing the following is not very precise:

NVDA compatibility: 2022.3.3 and beyond

Actually, it indicates the first compatible version but does not give the last compatible version. I prefer do this way anyway, because it's still an information that may be useful, e.g. on the community website or in the add-on.

So for now, I'll keep the documentation as is. I may reconsider dropping the compatibility information when the store indicates the compatibility range in "Ohter details" field, i.e. NVDA 2024.2, or if and when the community website is withdrawn.

I close this issue. But feel free to comment if you disagree and I may reopen.