Requirements Milestone 2 part a

askewseth / Concordanator

A java based application to create and search word concordances of public domain texts.

https://sible777.github.io/Concordanator

MIT License

0 stars 1 forks source link

Requirements Milestone 2 part a #1

Closed corysabol closed 8 years ago

corysabol commented 8 years ago

Comment any questions about each req here that you may have asked that need an answer or questions that you asked but found the answer to.

For each req a list of questions that
1. That need an answer
2. That you have asked, and the answer you have found
A graph or table of dependencies
How will we test the requirements
Implications of the requirement for implementation

Of course this can all be read in the document provided by Oldham.

corysabol commented 8 years ago

Does the command line interface need to be a standalone window that opens then launched? I can write a class for this. Or maybe @askewseth can work on that?

askewseth commented 8 years ago

How do we determine line number? Do we include the beginning (header)? Do we include blank lines? Do we index by page number or only by raw line number, ex) page 57 line 30 vs line 3,692

Do we need to deal with things like hyphenated words? ex) self-worth =? self worth

I'm assuming that we need to ignore cases, but it was never explicitly mentioned so just in case.

What makes something a common word? Are we supposed to make a list of common words such as articles and filter those out or are we supposed to allow the user to define words they don't care about?

On Tue, Feb 2, 2016 at 1:42 PM, Cory Sabol notifications@github.com wrote:

Does the command line interface need to be a standalone window that opens then launched? I can write a class for this. Or maybe @askewseth https://github.com/askewseth can work on that?

— Reply to this email directly or view it on GitHub https://github.com/sible777/Concordanator/issues/1#issuecomment-178750830 .

askewseth commented 8 years ago

Yeah I can work on the CLI if y'all want me to. But if I'm not mistaken the CLI is really just a wrapper for all of the other classes, just making them callable from the command line, and if that's the case then I wouldn't really be able to accomplish much on it until I had the rest of the program to call.

corysabol commented 8 years ago

@askewseth Those are some really great questions! I would assume that we can simply let user search for a hyphenated word and only return that exact string. We can use regex to math a little better, but that's a bit of a hassle.

As for the cli, yeah I think that's just a wrapper. Once we have the shell up and such then you can just include the empty classes you would depend on for full functionality.

You can break it down into features and work on the ones that can stand by themselves. Like parsing the command line args into tokens and such.

corysabol commented 8 years ago

Closing issue