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

Investigating outdated Doclang Constructors (ciGetDocDesc) #2541

Closed
Awurama-N opened this issue May 31, 2021 · 5 comments
Closed

Investigating outdated Doclang Constructors (ciGetDocDesc) #2541

Awurama-N opened this issue May 31, 2021 · 5 comments
Assignees

Comments

@Awurama-N
Copy link
Contributor

This is to investigate the removal of Doclang constructore ciGetDocDesc

(details in Issue #1602 )

@Awurama-N
Copy link
Contributor Author

Awurama-N commented May 31, 2021

ciGetDocDesc is defined in Drasil.ExtractDocDesc

ciGetDocDesc :: DocDesc -> [CI]
ciGetDocDesc = fmGetDocDesc ciPlate

ciGetDocDesc is only found in Doclang and Drasil.ExtractDocDesc

It seems obsolete.

My conclusion is that ciGetDocDesc can be deleted.
I have attempted to do this and did not face any issues or conflicts.
should I go ahead and make these changes?
@JacquesCarette

@Awurama-N Awurama-N self-assigned this May 31, 2021
@JacquesCarette
Copy link
Owner

Yes.

@Awurama-N
Copy link
Contributor Author

Awurama-N commented Jun 1, 2021

Below is the definition of ciGetDocDesc

ciGetDocDesc :: DocDesc -> [CI]
ciGetDocDesc = fmGetDocDesc ciPlate

its definition contains ciPlate, which seems to have been defined solely for the purpose of being used in the definition of ciGetDocDesc. Without ciGetDocDesc ciPlate becomes redundant.
Could i delete this as well? I experimented and realsied deleting it doesn't break anything.
I could also just comment it out of the working code instead.

@JacquesCarette @smiths

@JacquesCarette
Copy link
Owner

comment out ciPlate for now, don't delete it. What about fmGetDocDesc?

@Awurama-N
Copy link
Contributor Author

Awurama-N commented Jun 2, 2021

okay.
fmGetDocDesc is currently used in the definition of egetDocDesc and egetDocDesc is also used to define other things. So fmGetDocDesc is not obsolete.

egetDocDesc :: DocDesc -> [Expr]
egetDocDesc = fmGetDocDesc exprPlate

@JacquesCarette

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants