Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate and remove the dictionary file? #278

Open
martindholmes opened this issue Oct 4, 2023 · 2 comments
Open

Deprecate and remove the dictionary file? #278

martindholmes opened this issue Oct 4, 2023 · 2 comments
Assignees
Labels
deprecation Reminder that something should be deprecated release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Milestone

Comments

@martindholmes
Copy link
Collaborator

martindholmes commented Oct 4, 2023

@joeytakeda suggests that we're now only using the dictionary file for the processing report; if so, we can remove complexity and overhead by getting rid of it in 2.0. See also #195.

@martindholmes martindholmes self-assigned this Oct 4, 2023
@martindholmes martindholmes added release-blocker The dev branch must not be merged into master while a release-blocker bug is open. deprecation Reminder that something should be deprecated labels Oct 4, 2023
@martindholmes martindholmes added this to the Release 2.0 milestone Oct 4, 2023
joeytakeda added a commit that referenced this issue Nov 17, 2023
Note that I'm smuggling this in with the config cin support changes, since this requires changes to the config. However, ODD and documentation changes still need to be done, so can't be resolved without further work.
@martindholmes
Copy link
Collaborator Author

martindholmes commented Apr 18, 2024

As far as I can see, the only additional complexity involved is the fact that the report process uses the file, and in the past I've found it very useful for finding typos and spelling errors. How about this, instead:

  • dictionary file is optional in config
  • if it's not supplied, that part of the report process doesn't run, but if it is, the process does run.

So by supplying a dictionary file, you're telling the build process that you want a detailed report.

I do think we should relocate those files from the xsl folder, though; maybe to a lexicon folder, or something like that.

@martindholmes
Copy link
Collaborator Author

See also #186.

@martindholmes martindholmes modified the milestones: Release 2.0, Blue sky May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Reminder that something should be deprecated release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Projects
None yet
Development

No branches or pull requests

1 participant