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

[Feature] Move all the descriptions and tags to separate file to avoid redundancy #275

Closed
4 of 8 tasks
Nishith-Savla opened this issue May 24, 2023 · 7 comments
Closed
4 of 8 tasks
Assignees
Labels
enhancement New feature or request gssoc23 level1

Comments

@Nishith-Savla
Copy link
Contributor

Are you adding a new feature?

  • YES
  • NO

Are you enhancing the old feature?

  • YES
  • NO

Is your feature request related to a problem?

  • YES
  • NO

Describe your feature\enhancement.

Currently the list of endpoints shown on the index page has all the endpoints and their description hard coded which is duplicated in the particular function as well.
To avoid this, we can create a separate dict or a json file having all the project routes, tags, description and take values from there.

Can you add the feature by yourself?

  • YES
  • NO

Additional Information

I'm a GSSoC '23 Contributer.

After the refactoring, the function decorator would be something like this.

@app.get(CALCULATE_RETIREMENT_GOALS_ROUTE.name,
         tags=CALCULATE_RETIREMENT_GOALS_ROUTE.tags,
         description=CALCULATE_RETIREMENT_GOALS_ROUTE.description,
)
@ighoshsubho
Copy link
Collaborator

Sure go ahead @Nishith-Savla ;)

@ighoshsubho
Copy link
Collaborator

@Nishith-Savla is this done?

@Nishith-Savla
Copy link
Contributor Author

Sorry @ighoshsubho. Didn't get time to work on this. Starting work now. Will get a PR ready in a week

@Nishith-Savla
Copy link
Contributor Author

Nishith-Savla commented Jun 20, 2023

There are 3 functions for Calculating CAGR, should I remove one? If yes, which one?
Same for Future Value of Annuity (2 functions)
2 Functions for Profitability Index as well

@Nishith-Savla
Copy link
Contributor Author

Another thing, from line 528, we are using hyphens instead of dashes. Do we want to keep it like that or make it consistent?

@github-actions
Copy link

👋 @Nishith-Savla This issue is closed.

@Nishith-Savla Nishith-Savla closed this as not planned Won't fix, can't repro, duplicate, stale Oct 11, 2023
@github-actions
Copy link

👋 @Nishith-Savla This issue is closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gssoc23 level1
Projects
None yet
Development

No branches or pull requests

2 participants